Update API Service
PUT {{apiPath}}/environments/{{envID}}/apiServers/{{apiServerID}}
The PUT /environments/{{envID}}/apiServers/{{apiServerID}} modifies the attributes of the specified API service endpoint resource.
Prerequisites
- See PingOne Authorize and PingOne Authorize API Access Management for important overview information.
For property descriptions, see API service data model
| Property | Type? | Required? |
|---|---|---|
authorizationServer | Object | Required |
authorizationServer.resource | Relationship | Required |
authorizationServer.resource.id | UUID | Required |
baseUrls | Array | Required |
name | String | Required |
Request Body
{"name"=>"Updated Banking API", "baseUrls"=>["https://api.example.com/atmbanking/v1", "https://example-api.cdn/atmbanking/v1"], "authorizationServer"=>{"resource"=>{"id"=>"{{customP1ResourceID}}"}}}
RESPONSES
status: OK
{"_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"},"operations":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers/6cdedf90-f9e4-4c2e-b238-091adbb156fe/operations"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"id":"6cdedf90-f9e4-4c2e-b238-091adbb156fe","name":"Updated Banking API","baseUrls":["https://api.example.com/atmbanking/v1","https://example-api.cdn/atmbanking/v1"],"authorizationServer":{"resource":{"id":"d8a56a22-caf3-4053-8221-298a12e013ab"},"type":"PINGONE_SSO"},"directory":{"type":"PINGONE_SSO"}}