GET/api/apisAuthenticated

List API servers

Lists API server registrations. list_apis_query_type selects the scope: all (platform administrators only), org (members of the organization named by organization_id), owned (API servers owned by the caller's account) or accessible (every API server the caller can reach by ownership).

operationId get_api_apisAPI 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: all requires a platform administrator; org requires membership of that organization.

Query parameters

Name	Type	Description
list_apis_query_type	string	One of `all`, `org`, `owned`, `accessible` (required)
organization_id	string	Organization whose API servers to list; required when `list_apis_query_type` is `org`

Responses

application/json

ListApiServersResponse

Property	Type	Description
success*	true
message*	string
list*	ApiServerDefinition[]
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

"message""string"

"list"

"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' \
  -b 'refresh_token_<auth_server_app_id>=<value>'

Other methods on this path

POSTRegister an API server

Authentication & permissionsAuthenticated

Query parameters

Responses

200The API servers in the requested scope

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

500Failed to list API servers

Example request

Other methods on this path