api dox

aa11 I've updated the original example to use json= instead of data= in the API call.

If you use that example with [] as your destinations and valid addresses in the source and forwards then it should work.

Note that all of the addresses must have valid domain names so if you're actually trying to use "MY_DOMAIN.com" that won't work (since underscores aren't allowed in domain names).

sean I've updated the original example to use json= instead of data= in the API call.

That did it!

I saw cornelius use data=json.dumps() but couldn't get that to work either. Switching from data= to json= did the trick.

Also, having that debugging output (viar.status_code and r.text) is helpful.

Note that all of the addresses must have valid domain names so if you're actually trying to use "MY_DOMAIN.com" that won't work (since underscores aren't allowed in domain names).

Of course. But good thing to mention.

Thanks!!

For those of you playing along at home, we've recently pushed an update that changed the various API endpoints for mail users from /mail/user to /mailuser.

The generated API refs will be updated soon.

Hah! The tool I used to allow my users to change their mailbox passwords after migration from WF was crashing the other day. I tracked down the changes and fixed my code.

The people at Opalstack are really helpful and crazy fast at responding to issues raised both here or through tickets. It would be helpful though if we had some mailing list or RSS feed to keep updated with both changes and new stuff at Opalstack (maybe I don't know about it...). It would a lot of time for both chasing and error introduced by a changes like this and to the good people at Opalstack who answer our questions.

gelu We're not officially publishing changes to the API because the API itself has not been officially released.

Once we've finalized the API and have fully documented everything, then we'll start managing changes publicly.

API working great -- going to save my skin doing 100's of email account migrations -- thanks!

Having trouble with api/v0/mailuser/pwdch/ --> 400 Bad Request {"error": "INVALID"}
Here's my code:

    r = requests.post(
        'https://my.opalstack.com/api/v0/mailuser/pwdch/',
        auth=TokenAuth(TOKEN),
        json={
             'id': 'd035b2b7-c55b-413b-a5f1-4edbe7ea5de0', 
             'password': 'some password'
           },
   )
  print (r.status_code, r.reason, r.text)
  > 400 Bad Request {"error": "INVALID"}

No problem with other requests.
I have tried all combinations of data= vs. json= and json.dumps() vs. normal dict
Any ideas what I'm doing dumb here appreciated.

dcd pwdch takes a list, try this:

    r = requests.post(
        'https://my.opalstack.com/api/v0/mailuser/pwdch/',
        auth=TokenAuth(TOKEN),
        json=[{
             'id': 'd035b2b7-c55b-413b-a5f1-4edbe7ea5de0', 
             'password': 'some password'
           }],
   )

sean Damn. No Dice Sean. Here's a complete session with just a few details redacted, hopefully give a clue what dumb-ass thing I am doing...

mailbox_id = 'd035b2b7-c55b-413b-a5f1-4edbe7ea5de0'
... r = requests.get(
...     'https://my.opalstack.com/api/v0/mailuser/read/{}'.format(mailbox_id),
...     auth = TokenAuth(TOKEN),
... )
... print(r, r.content)
... 
<Response [200]> b'{"id": "d035b2b7-c55b-413b-a5f1-4edbe7ea5de0", "name": "<xxx>", "pending_deletion": false, "ready": true, "imap_server": "<uuid>", "init_created": true}'
r = requests.post(
...     'https://my.opalstack.com/api/v0/mailuser/pwdch/',
...     auth=TokenAuth(TOKEN),
...     json=[{
...         'id'      : mailbox_id,
...         'password': 'some password'
...     }],
... )
... print(r, r.reason)
... 
<Response [400]> Bad Request

dcd Proof in the pudding:

... r = requests.post(
...     'https://my.opalstack.com/api/v0/mailuser/pwdch/',
...     auth=TokenAuth(TOKEN),
...     json=[{
...         'id'      : mailbox_id,
...         'password': 's0me P@ssword'
...     }],
... )
... print(r, r.reason)
... 
<Response [200]> OK

as of June 2021 the API is at v1. The new docs are:

https://my.opalstack.com/api/v1/doc/
https://my.opalstack.com/api/v1/redoc/

Any chance you can add to the docs where lists are required? Got caught with DNSRecord/Update failing in my ddns script due to not passing a list. I know you have mentioned that lists are now required at a number of end points, would be great if those can be called out in the V1 docs. Thanks!

allyn I believe all create endpoints require lists now.