AthausDoku

Delete a webhook endpoint

Aufruf, Parameter, Antwort und Fehler von DELETE /v1/webhookEndpoints/{id}.

Zuletzt aktualisiert:

Removes the endpoint. Deliveries that are queued for it are dropped. Needs write access to webhookEndpoints.

Braucht den Scope propose.

Aufruf

DELETE https://api.athaus.ai/v1/webhookEndpoints/{id}

Parameter

Pfad

NameTypPflichtBeschreibung
idstring (uuid)jaUUID of the webhook endpoint.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported.
If-MatchstringneinOnly if the current ETag of the resource is listed (or *: only if the resource exists). Otherwise 412 and nothing is written.

Beispiel

curl -X DELETE "https://api.athaus.ai/v1/webhookEndpoints/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..."

Antwort

Bei Erfolg kommt 200 mit WebhookEndpointDeleted.

WebhookEndpointDeleted

FeldTypBeschreibung
objectstringImmer webhook_endpoint.
idstring
deletedbooleanImmer true.

Köpfe der Antwort

KopfBeschreibung
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

StatusCodesBedeutung
400invalid_id, api_version_unsupported, invalid_inputInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
409The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
412precondition_failedThe condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Weiter lesen

Auf dieser Seite