GET
/api/apis/{api_server_id}AuthenticatedGet an API server
Loads one API server registration. Private (not publicly listed) API servers are only visible to platform administrators, members of the owning organization, or the owning user.
operationId
get_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
Path parameters
| Name | Type | Description |
|---|---|---|
| api_server_id* | string | API server id |
Responses
application/json
ApiServerResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| api_server* | ApiServerDefinition | An API server (resource server) registration: identity, listing visibility, ownership (platform / organization / user) and dynamic-client policy. |
| api_server_id* | string | minLength: 2maxLength: 64pattern: ^[a-z0-9_-]*$ |
| api_server_name* | string | maxLength: 64 |
| api_server_description* | string | maxLength: 512 |
| created_at* | number | minimum: 0 |
| public* | boolean | |
| hardcoded* | boolean | |
| owner_type | "platform" | "organization" | "user" | "dynamic-client-registration" | |
| owner_organization_id | string | null | null | |
| owner_uid | string (uuid) | null (uuid) | null | |
| created_by | string (uuid) | null (uuid) | null | |
| allow_dynamic_clients | boolean | |
| resource_url_match_mode | "exact" | "prefix" |
JSONExample
"success"true
"api_server"
"api_server_id""string"
"api_server_name""string"
"api_server_description""string"
"created_at"1.5
"public"true
"hardcoded"true
"owner_type""platform"
"owner_organization_id""string"
"owner_uid""123e4567-e89b-12d3-a456-426614174000"
"created_by""123e4567-e89b-12d3-a456-426614174000"
"allow_dynamic_clients"true
"resource_url_match_mode""exact"
Example request
bashcurl
curl -X GET 'https://auth.schemavaults.com/api/apis/<api_server_id>' \
-b 'refresh_token_<auth_server_app_id>=<value>'