API reference
Projects
GET
Limits with current use, and the restrictions staff may have set: creating resources disabled altogether
(creation_blocked, with a reason) or in some locations (blocked_locations). Readable by every member of
the project, so panels can disable create buttons before a request fails.
header
AuthorizationBearer <token>Quota
application/json- response
quota*curl -X GET "https://example.com/quota"{ "quota": { "account_status": "active", "creation_blocked": true, "creation_block_reason": "string", "blocked_locations": [ "string" ], "limits": { "property1": { "limit": 0, "used": 0 }, "property2": { "limit": 0, "used": 0 } } }}GET
cookieAuthcookie
odx_session<token>Projects
application/json- response
projects*array<>curl -X GET "https://example.com/projects"{ "projects": [ { "id": 0, "name": "string", "organization_id": 0, "role": "admin", "created": "2019-08-24T14:15:22Z" } ]}POST
cookieAuthcookie
odx_session<token>application/json- body
name*stringLength
1 <= length <= 64organization_id?integerDefaults to the personal organization
Format
int64Created
application/json- response
project*curl -X POST "https://example.com/projects" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "project": { "id": 0, "name": "string", "organization_id": 0, "role": "admin", "created": "2019-08-24T14:15:22Z" }}GET
cookieAuthcookie
odx_session<token>id*integerFormat
int64Project
application/json- response
project*curl -X GET "https://example.com/projects/0"{ "project": { "id": 0, "name": "string", "organization_id": 0, "role": "admin", "created": "2019-08-24T14:15:22Z" }}PATCH
cookieAuthcookie
odx_session<token>id*integerFormat
int64application/json- body
name*stringLength
1 <= length <= 64Updated
application/json- response
project*curl -X PATCH "https://example.com/projects/0" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "project": { "id": 0, "name": "string", "organization_id": 0, "role": "admin", "created": "2019-08-24T14:15:22Z" }}DELETE
Fails with project_not_empty while the project still has resources.
cookieAuthcookie
odx_session<token>id*integerFormat
int64Deleted
curl -X DELETE "https://example.com/projects/0"Empty
GET
cookieAuthcookie
odx_session<token>id*integerFormat
int64Tokens (secrets are never returned again)
application/json- response
tokens*array<>curl -X GET "https://example.com/projects/0/tokens"{ "tokens": [ { "id": 0, "name": "string", "prefix": "string", "scope": "read", "created": "2019-08-24T14:15:22Z", "expires": "2019-08-24T14:15:22Z", "last_used": "2019-08-24T14:15:22Z" } ]}POST
cookieAuthcookie
odx_session<token>id*integerFormat
int64application/json- body
name*stringLength
1 <= length <= 64scope*stringValue in
"read""read_write"expires_in_days?integerRange
1 <= value <= 3650Created. secret is shown only in this response.
application/json- response
token*secret*stringcurl -X POST "https://example.com/projects/0/tokens" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "scope": "read" }'{ "token": { "id": 0, "name": "string", "prefix": "string", "scope": "read", "created": "2019-08-24T14:15:22Z", "expires": "2019-08-24T14:15:22Z", "last_used": "2019-08-24T14:15:22Z" }, "secret": "odx_k3j2h1_2fK9..."}DELETE
cookieAuthcookie
odx_session<token>id*integerFormat
int64token_id*integerFormat
int64Revoked
curl -X DELETE "https://example.com/projects/0/tokens/0"Empty