POST/disable

Disable the API

Triggers API disablement for the instance. Use this operation only when you have root permissions; the response confirms the API was disabled.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 status codes
200Returns a message confirming that the API was disabled.
messagestringoptional
400Returned when the authentication token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when the authenticated user is not allowed to disable the API.
messagestringoptional

Error handling

A 400 is returned when the authentication token is invalid. A 401 is returned when the request is unauthenticated. A 403 is returned when the authenticated user does not have root permissions to disable the API.