Create API Gateway Integration
POST {{apiPath}}/environments/{{envID}}/gateways
The POST /environments/{{envID}}/gateways operation adds a new gateway resource to the specified environment resource. This sample shows how to create a gateway of type API_GATEWAY_INTEGRATION, which identifies a PingOne API Access Management gateway resource. For more information about access management, see PingOneAuthorize API Access Management.
Prerequisites
- See Gateway Management for important overview information.
For property descriptions, see Gateway base data model.
| Property | Type | Required? |
|---|---|---|
description | String | Optional |
enabled | Boolean | Required |
name | String | Required |
type | String | Required |
Request Body
{"name"=>"API-Gateway-Test", "description"=>"My API gateway", "type"=>"API_GATEWAY_INTEGRATION", "enabled"=>true}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways/8759fbba-d3a2-4f45-80a5-d92c87099484"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"instances":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways/8759fbba-d3a2-4f45-80a5-d92c87099484/instances"}},"id":"8759fbba-d3a2-4f45-80a5-d92c87099484","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"API-Gateway-Test","description":"My API gateway","type":"API_GATEWAY_INTEGRATION","enabled":true}