Skip to content

Latest commit

 

History

History
78 lines (43 loc) · 2.04 KB

API_CHANGELOG.md

File metadata and controls

78 lines (43 loc) · 2.04 KB

This changelog notes changes to API endpoints that are documented and listed through Swagger. Changes to undocumented, internal CATMAID APIs are not included in this changelog.

2015.12.21

The CATMAID API now authorizes requests using an API token tied to your account instead of your username and password. To obtain this token, open the CATMAID client in your browser, hover your cursor over your name (next to the "Logout" link), and click "Get API token". As a security measure, you will be prompted to re-enter your password, then shown your token string.

To use the API token, set the HTTP X-Authorization header on all of your API requests to be 'Token', a space, and the token string, e.g.:

X-Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b

Additions

  • GET /projects/: List projects visible to the requesting user.

  • GET /client/datastores/: List key-value store datastores used by the client.

  • POST /client/datastores/: Create a key-value store datastore for the client.

  • DELETE /client/datastores/{name}: Delete a key-value store datastore for the client.

  • GET /client/datastores/{name}/: List key-value data in a datastore for the client.

  • PUT /client/datastores/{name}/: Create or replace a key-value data entry for the client.

  • POST /{project_id}/volumes/{volume_id}/: Get detailed information on a spatial volume or set its properties.

Modifications

GET /{project_id}/annotations/:

  • Params are now correctly documented as form rather than query params.

POST /{project_id}/annotations/:

  • Params are now correctly documented as form rather than query params.

POST /{project_id}/annotations/forskeletons:

  • Params are now correctly documented as form rather than query params.

POST /{project_id}/skeletons/connectivity:

  • boolean_op form param now expects string "AND" or "OR" rather than "logic-AND" or "logic-OR".

POST /{project_id}/volumes/add:

  • Params are now correctly documented as form rather than query params.

Deprecations

None.

Removals

None.