API reference · Your application

Suspend your application

POST/v1/application/suspend

POST /v1/application/suspend stops your own application immediately. Only Anis staff can resume it.

PermissionNone
AuthenticationSigned change
Anis’s answerSigned
Staff-set limits it counts towardAll requests
.NET SDKclient.Access.SuspendApplicationAsync(reason)
  • 200 signed answer: {"applicationId":"<uuid>","status":"suspended","suspendedAt":"<RFC3339>"}. An already-suspended application returns its current state if the request is admitted; later requests are refused by admission.
  • Every stop emails your technical contact. A stop initiated by your team also emails support@anis.ly. If you have lost the private key entirely, contact support@anis.ly.

Request

Signed with your key, with a one-time nonce and a digest of the body.

Headers: Signature-Input, Signature, Content-Digest, Nonce, X-Anis-Date. The SDKs set all of them for you.

Body: {"reason":"Suspected compromise"} — required text, trimmed, 1 to 500 characters. Sign the body digest with a fresh nonce; no Idempotency-Key or scope is required for an admitted request.

Responses

StatusMeaningBody
200Success.ApplicationSuspended
400Refused: the signed request is badly built.Problem
401Refused: not authenticated.Problem
403Refused: not allowed.Problem
404Refused: not found, or not yours.Problem
409Refused: conflicts with the current state.Problem
422Refused: the request breaks a rule.Problem
429Refused: a limit was reached.Problem
503No decision: a dependency was unavailable.Problem

Every answer of this call is signed by Anis — success and every refusal. Require the signature and verify it before you act on the answer; an answer without one is a failure, never an answer (how).

Refusals

Every refusal of this call is a signed problem. Branch on its code; each links to what it means and what to do.

ErrorCodeStatus
Invalid credentialsinvalid_credentials401
Malformed signed requestmalformed_signed_request400
Source address not allowedsource_ip_not_allowed403
Rate limitedrate_limited429
Replay detectedreplay_detected409
Validation failedvalidation_failed422
Not foundresource_not_found404
Service unavailabledependency_unavailable503
Request timeoutrequest_timeout504
Internal errorinternal_error500

Types

ApplicationSuspended

FieldTypeNotes
applicationIdalways presentUUIDThe id of your suspended application.
statusalways presentstringAlways suspended. Only Anis staff can resume the application. Values: suspended
suspendedAtalways presentstring (date-time)When the application was suspended, as an RFC3339 timestamp.