API reference · Access and identity
Support sign-in
7 operations of the Ankra Cloud API: Independent Ankra Support identity handoff.
Sign in to the independent Ankra Support service#
/v1/support/connect- Operation
create_support_identity- Credentials
- Portal session
- Requires
- Permission
read
Responses
200Single-use assertion, to POST to Support within one minute.application/json
| Field | Type | Description |
|---|---|---|
assertionrequired | string | |
actionrequired | string |
- 401Not signed in, or the credential is invalid or expired.
- 403The role lacks the permission, the token is read-only (a read-only token also gets
reason: read_only_token_cannot_read_credentialson every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified). - defaultAny other error, usually 500.
Example
curl -X POST 'https://cloud.ankra.app/v1/support/connect' \
-b "ankracloud_session=$SESSION" \
-H "X-CSRF-Token: $CSRF_TOKEN"List central Support tickets#
/v1/support/tickets- Operation
list_support_tickets- Credentials
- API token, Portal session
- Requires
- Permission
read
Uses support.ankra.app with your authenticated account and verified Platform organisation link. No separate Support token is needed. Organisation-wide access is required; private staff notes are excluded. Include only relevant resource identifiers and error details, never credentials or environment dumps. A timed-out write may have completed: list or read the ticket before retrying.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
cursor | query | string | next_cursor from the preceding page; continue until empty. |
Responses
200Central Support result. Lists return items and next_cursor; ticket identifiers are UUIDs.application/json
- 401Not signed in, or the credential is invalid or expired.
- 403The role lacks the permission, the token is read-only (a read-only token also gets
reason: read_only_token_cannot_read_credentialson every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified). - 429Rate limited. On a customer operation the credential (the API token, or the signed-in user for a session) is over its requests per minute and the
X-RateLimit-*headers say when the window ends; on a sign-in route the client network is over its attempts or the email is locked out. - defaultAny other error, usually 500.
Example
curl 'https://cloud.ankra.app/v1/support/tickets' \
-H "Authorization: Bearer $ANKRA_CLOUD_TOKEN"Contact Ankra through central Support#
/v1/support/tickets- Operation
create_support_ticket- Credentials
- API token, Portal session
- Requires
- Permission
operate
Uses support.ankra.app with your authenticated account and verified Platform organisation link. No separate Support token is needed. Organisation-wide access is required; private staff notes are excluded. Include only relevant resource identifiers and error details, never credentials or environment dumps. A timed-out write may have completed: list or read the ticket before retrying.
Request bodyapplication/json · SupportTicketCreate
| Field | Type | Description |
|---|---|---|
productrequired | string | One of cloud, platform |
subjectrequired | string | |
descriptionrequired | string | |
priority | string | One of low, normal, high, urgent |
context | object | |
resource_id | string | |
request_id | string | |
region | string | |
error_code | string | |
client_version | string | |
cluster_id | string | |
page_path | string | Path only; omit query strings and fragments. |
Responses
201Central Support result. Lists return items and next_cursor; ticket identifiers are UUIDs.application/json
- 401Not signed in, or the credential is invalid or expired.
- 403The role lacks the permission, the token is read-only (a read-only token also gets
reason: read_only_token_cannot_read_credentialson every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified). - 429Rate limited. On a customer operation the credential (the API token, or the signed-in user for a session) is over its requests per minute and the
X-RateLimit-*headers say when the window ends; on a sign-in route the client network is over its attempts or the email is locked out. - defaultAny other error, usually 500.
Example
curl -X POST 'https://cloud.ankra.app/v1/support/tickets' \
-H "Authorization: Bearer $ANKRA_CLOUD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"product": "cloud",
"subject": "string",
"description": "string"
}'Read a central Support ticket#
/v1/support/tickets/{id}- Operation
get_support_ticket- Credentials
- API token, Portal session
- Requires
- Permission
read
Uses support.ankra.app with your authenticated account and verified Platform organisation link. No separate Support token is needed. Organisation-wide access is required; private staff notes are excluded. Include only relevant resource identifiers and error details, never credentials or environment dumps. A timed-out write may have completed: list or read the ticket before retrying.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
Responses
200Central Support result. Lists return items and next_cursor; ticket identifiers are UUIDs.application/json
- 401Not signed in, or the credential is invalid or expired.
- 403The role lacks the permission, the token is read-only (a read-only token also gets
reason: read_only_token_cannot_read_credentialson every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified). - 429Rate limited. On a customer operation the credential (the API token, or the signed-in user for a session) is over its requests per minute and the
X-RateLimit-*headers say when the window ends; on a sign-in route the client network is over its attempts or the email is locked out. - defaultAny other error, usually 500.
Example
curl 'https://cloud.ankra.app/v1/support/tickets/<id>' \
-H "Authorization: Bearer $ANKRA_CLOUD_TOKEN"Close or reopen a central Support ticket#
/v1/support/tickets/{id}- Operation
update_support_ticket- Credentials
- API token, Portal session
- Requires
- Permission
operate
Uses support.ankra.app with your authenticated account and verified Platform organisation link. No separate Support token is needed. Organisation-wide access is required; private staff notes are excluded. Include only relevant resource identifiers and error details, never credentials or environment dumps. A timed-out write may have completed: list or read the ticket before retrying.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
Request bodyapplication/json · SupportTicketUpdate
| Field | Type | Description |
|---|---|---|
versionrequired | integer | Current version from get_support_ticket. |
statusrequired | string | One of open, closed |
Responses
200Central Support result. Lists return items and next_cursor; ticket identifiers are UUIDs.application/json
- 401Not signed in, or the credential is invalid or expired.
- 403The role lacks the permission, the token is read-only (a read-only token also gets
reason: read_only_token_cannot_read_credentialson every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified). - 429Rate limited. On a customer operation the credential (the API token, or the signed-in user for a session) is over its requests per minute and the
X-RateLimit-*headers say when the window ends; on a sign-in route the client network is over its attempts or the email is locked out. - defaultAny other error, usually 500.
Example
curl -X PATCH 'https://cloud.ankra.app/v1/support/tickets/<id>' \
-H "Authorization: Bearer $ANKRA_CLOUD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"version": 1,
"status": "open"
}'Read public replies on a central Support ticket#
/v1/support/tickets/{id}/messages- Operation
list_support_ticket_messages- Credentials
- API token, Portal session
- Requires
- Permission
read
Uses support.ankra.app with your authenticated account and verified Platform organisation link. No separate Support token is needed. Organisation-wide access is required; private staff notes are excluded. Include only relevant resource identifiers and error details, never credentials or environment dumps. A timed-out write may have completed: list or read the ticket before retrying.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) | |
cursor | query | string | next_cursor from the preceding page; continue until empty. |
Responses
200Central Support result. Lists return items and next_cursor; ticket identifiers are UUIDs.application/json
- 401Not signed in, or the credential is invalid or expired.
- 403The role lacks the permission, the token is read-only (a read-only token also gets
reason: read_only_token_cannot_read_credentialson every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified). - 429Rate limited. On a customer operation the credential (the API token, or the signed-in user for a session) is over its requests per minute and the
X-RateLimit-*headers say when the window ends; on a sign-in route the client network is over its attempts or the email is locked out. - defaultAny other error, usually 500.
Example
curl 'https://cloud.ankra.app/v1/support/tickets/<id>/messages' \
-H "Authorization: Bearer $ANKRA_CLOUD_TOKEN"Reply to Ankra on a central Support ticket#
/v1/support/tickets/{id}/messages- Operation
create_support_reply- Credentials
- API token, Portal session
- Requires
- Permission
operate
Uses support.ankra.app with your authenticated account and verified Platform organisation link. No separate Support token is needed. Organisation-wide access is required; private staff notes are excluded. Include only relevant resource identifiers and error details, never credentials or environment dumps. A timed-out write may have completed: list or read the ticket before retrying.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
Request bodyapplication/json · SupportTicketReply
| Field | Type | Description |
|---|---|---|
bodyrequired | string |
Responses
201Central Support result. Lists return items and next_cursor; ticket identifiers are UUIDs.application/json
- 401Not signed in, or the credential is invalid or expired.
- 403The role lacks the permission, the token is read-only (a read-only token also gets
reason: read_only_token_cannot_read_credentialson every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified). - 429Rate limited. On a customer operation the credential (the API token, or the signed-in user for a session) is over its requests per minute and the
X-RateLimit-*headers say when the window ends; on a sign-in route the client network is over its attempts or the email is locked out. - defaultAny other error, usually 500.
Example
curl -X POST 'https://cloud.ankra.app/v1/support/tickets/<id>/messages' \
-H "Authorization: Bearer $ANKRA_CLOUD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"body": "string"
}'