POST
/api/apis/{api_server_id}/domainsAuthenticatedAdd a domain to an API server
Registers a domain for the API server in one app environment. The body's api_server_id must equal the path parameter. The same domain may be registered once per environment.
operationId
post_api_apis_api_server_id_domainsAPI 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/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 |
Request body
Required — The domain to register; api_server_id must match the path.
application/json
ApiServerDomainRefA domain an API server is reachable at in one app environment.
| Property | Type | Description |
|---|---|---|
| api_server_domain_ref_id* | string (uuid) | |
| api_server_id* | string | minLength: 2maxLength: 64pattern: ^[a-z0-9_-]*$ |
| domain* | string | maxLength: 255 |
| environment* | "development" | "staging" | "test" | "production" | |
| created_at* | number | minimum: 0 |
| hardcoded* | boolean |
JSONExample
"api_server_domain_ref_id""123e4567-e89b-12d3-a456-426614174000"
"api_server_id""string"
"domain""string"
"environment""development"
"created_at"1.5
"hardcoded"true
Responses
application/json
ResourceCreationResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| resource_id* | string | Identifier of the created / affected resource |
JSONExample
"success"true
"message""string"
"resource_id""string"
Example request
bashcurl
curl -X POST 'https://auth.schemavaults.com/api/apis/<api_server_id>/domains' \
-b 'refresh_token_<auth_server_app_id>=<value>' \
-H 'Content-Type: application/json' \
-d '{
"api_server_domain_ref_id": "123e4567-e89b-12d3-a456-426614174000",
"api_server_id": "string",
"domain": "string",
"environment": "development",
"created_at": 1.5,
"hardcoded": true
}'