Soft-delete a global integrator Mark a global integrator inactive without removing its row

DELETE /api/configuration/admin/integrators/{id}

Products: not restricted by product
Features: Gladstone Admin Areas (ADMIN)

Overview

Retires an integrator by setting its isActive flag to false. The integrator is not deleted, its audit trail is not touched, and its API keys keep their Active status — but they stop working.

This is not a quiet catalogue change; it cuts off live traffic. Key validation requires the owning integrator to be active, so from the moment this call succeeds, every API key issued under this integrator fails with 401 at the token endpoint. For a global integrator that means every tenant that had activated it, not just yours — there is no per-tenant scoping on this operation.

Two timings matter when you are planning a retirement:

Token issuance stops within five minutes, not instantly. A key that was used in the five minutes before the call can keep minting tokens for up to five minutes afterwards. The private-integrator delete and the key revoke and renew endpoints do not have this delay.
Access tokens already issued keep working until they expire. The API key is only checked when a token is minted, so an integration holding a valid bearer token continues to call the platform for the remainder of that token's lifetime — read expiresIn from the token response to know how long.

To undo this, call Update a global integrator with isActive true. Because the keys were never revoked, they start working again — you do not need to reissue them. That is a deliberate difference from Deactivate a global integrator for the current tenant, which revokes the key itself and cannot be undone.

This endpoint is restricted to Gladstone Support: the endpoint rejects any caller whose token does not carry the ADMIN feature claim.

Endpoint

DELETE {base_url}/api/configuration/admin/integrators/{id}

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Name	Type	Required	Description
`id`	integer (int32)	Yes	The identifier of the integrator to retire, as returned in the `id` field of List all global integrators. The endpoint does not check that the id belongs to a global integrator — despite the endpoint's name, passing the id of any tenant's private integrator retires that integrator instead, revoking nothing but breaking its keys. Verify the id against the global catalogue before you call.

Sample request

cURL

curl -X DELETE '{base_url}/api/configuration/admin/integrators/{id}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Errors

Status	Meaning	When
`204`	No content	Success. The response has no body — reread the integrator if you want to confirm the new state.
`403`	Forbidden	Your token does not carry the `ADMIN` feature claim. The response has no body. This endpoint is reserved for Gladstone Support; a tenant integration cannot call it whatever its other scopes.
`404`	Not found	No integrator exists with that id at all. Note that an id belonging to a private integrator is not a `404` here — it succeeds. Calling this on an integrator that is already inactive is also not a `404`; it returns `204` and changes nothing but `modifiedOn` and `modifiedBy`.
`500`	Internal server error	Any unexpected server-side failure. The body is empty. The change is all-or-nothing, so either the integrator was retired or nothing changed.

This page as markdown · All pages · llms.txt