Read API Services

GET {{apiPath}}/environments/{{envID}}/apiServers

The GET /environments/{{envID}}/apiServers operation returns all API service endpoint resources associated with the environment. This request supports the limit query parameter. For more information, see the Paging, ordering, and filtering collections section of Conventions.

Query parameterDescription
limitSets the number of records returned per page.

Request Params

KeyDatatypeRequiredDescription
limitnumberSets the number of records returned per page.

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers"}},"_embedded":{"apiServers":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers/6cdedf90-f9e4-4c2e-b238-091adbb156fe"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/d8a56a22-caf3-4053-8221-298a12e013ab"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"operations":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers/6cdedf90-f9e4-4c2e-b238-091adbb156fe/operations"}},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"id":"6cdedf90-f9e4-4c2e-b238-091adbb156fe","name":"Banking API-Advanced","baseUrls":["https://api.example.com/advbanking/v1","https://example-api.cdn/advbanking/v1"],"authorizationServer":{"resource":{"id":"d8a56a22-caf3-4053-8221-298a12e013ab"},"type":"PINGONE_SSO"},"directory":{"type":"PINGONE_SSO"}}]},"count":1,"size":1}