api dox

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 I think I got it. My passwords arer long and random, but did not contain any upper-case letter.
Saw a tip on another thread to watch XHR requests while doing operations via control panel -- excellent tip, that gave me the answers I needed. Thanks Sean, sorry for the diversion.

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!