DELETE/api/apis/{api_server_id}/domains/{api_server_domain_ref_id}Authenticated

Remove a domain from an API server

Detaches a domain from an API server: RFC 8707 resource URLs on it no longer resolve to the API server. Hardcoded API servers take their domains from the server's environment and cannot be configured.

operationId delete_api_apis_api_server_id_domains_api_server_domain_ref_idAPI servers

Authentication & 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>
Who may call: Any authenticated user
Notes: Organization owners/admins of the owning organization, the owning user of a user-owned API server, or platform administrators.

Path parameters

Name	Type	Description
api_server_id*	string	API server id
api_server_domain_ref_id*	string (uuid)	The API server domain reference 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>/domains/<api_server_domain_ref_id>' \
  -b 'refresh_token_<auth_server_app_id>=<value>'

Authentication & permissionsAuthenticated

Path parameters

Responses

200The domain was removed

400The request failed validation (issues lists the offending fields) or was refused by the handler

401No valid session cookie, access token cookie or bearer access token was presented, or the token was revoked

403The account is disabled, or the credential is valid but not allowed to perform this operation

404No such API server, or no domain with the given id for this API server

500Failed to remove the domain

Example request