ways2list4objects

dragonxi

(1) How to get the list as admin about the objects configured and with their full name ?
Example objects:
(a) email addresses
(b) email users
(c) domains
(d) shell users
(e) applications
(f) routes

(2) Using Linux commands, which ones ?
(3) Any scripts available, where, URL ?
(4) PHP to print the lists, which .php, URL ?

Thanks in advance for any good advice!

Note: the current opalstack server softare uses in many cases 16 as display length for objects it accepts 32 length, which makes it difficult and often impossible to see full name of objects without going to edit it - and sometimes the server then displays object code not its name.

sean

You can use our API to get lists of the items that you've created in the dashboard.

To get started, first create an API token at https://my.opalstack.com/tokens/.

After you have a token you can use any scripting language that can communicate with a REST API.

Here's a short Python3 example to print a list of email addresses - it used the 3rd-party "requests" library so you'll need to have that installed if you're running this locally.:

import requests

OPAL_TOKEN = 'YOUR_TOKEN_HERE'
OPAL_HEADERS = {
    'Authorization': f'Token {OPAL_TOKEN}',
    'Content-Type':'application/json'
}
emails = requests.get(
    'https://my.opalstack.com/api/v0/mail/list/',
    headers=OPAL_HEADERS
).json()['mails']

for addr in sorted([i['address'] for i in emails]):
    print(addr)

This same technique can be used to get info from any of the various list methods in the API.

Sometimes the results will include UUIDs for related objects - to get the details for those, use the appropriate API read method for whatever type of object.

dragonxi

Thanks a lot, rock solid professional support with the open API more and more rare to find, I'll pass your advice to our Python guys.

sean

dragonxi Python's not a requirement for this, you can use any scripting language as long as it has the capability to consume JSON responses from a REST API.