DELETE
/api/apis/{api_server_id}AuthenticatedDelete an API server
Deletes an API server registration together with its domains, JWKS access keys and app connections. Hardcoded API servers cannot be deleted.
operationId
delete_api_apis_api_server_idAPI serversAuthentication & permissionsAuthenticated
Any authenticated user
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Any authenticated user
- Notes
- Organization owners of the owning organization, the owning user of a user-owned API server, or platform administrators (platform-owned API servers: administrators only).
Path parameters
| Name | Type | Description |
|---|---|---|
| api_server_id* | string | API server id |
Responses
application/json
SuccessMessageResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string |
JSONExample
"success"true
"message""string"
Example request
bashcurl
curl -X DELETE 'https://auth.schemavaults.com/api/apis/<api_server_id>' \
-b 'refresh_token_<auth_server_app_id>=<value>'