Skip to content

Account

5 operations generated from the Engine OpenAPI schema. Request and response model names can be expanded in the interactive schema.

DELETE /api/v1/accounts/{id}

Delete an account by ID or username.

Authentication: Authorization header (ApiKeyAuth)

Parameters

NameLocationTypeRequiredDescription
idpathstringYesAccount ID or username

Responses

StatusDescriptionSchema
200OKroute.APIResponse

POST /api/v1/accounts/{id}/resume

Resume a suspended account.

Authentication: Authorization header (ApiKeyAuth)

Parameters

NameLocationTypeRequiredDescription
idpathstringYesAccount ID or username

Responses

StatusDescriptionSchema
200OKroute.APIResponse

POST /api/v1/accounts/{id}/sign-out

Invalidate an account’s management sessions.

Authentication: Authorization header (ApiKeyAuth)

Parameters

NameLocationTypeRequiredDescription
idpathstringYesAccount ID or username

Responses

StatusDescriptionSchema
200OKroute.APIResponse

POST /api/v1/accounts/{id}/suspend

Suspend an account.

Authentication: Authorization header (ApiKeyAuth)

Parameters

NameLocationTypeRequiredDescription
idpathstringYesAccount ID or username
reasonformDatastringYesSuspension reason
untilformDataintegerYesSuspension end time as a Unix timestamp; zero means indefinite

Responses

StatusDescriptionSchema
200OKroute.APIResponse

GET /api/v1/session/status

Get the current management session status.

Authentication: Authorization header (ApiKeyAuth)

Responses

StatusDescriptionSchema
200OKroute.APIResponse