Update RADIUS Gateway
PUT {{apiPath}}/environments/{{envID}}/gateways/{{gatewayID}}
You can use the PUT /environments/{{envID}}/gateways/{{gatewayID}} operation to update the details of an existing RADIUS gateway in your environment.
Points to note about the body of the request:
When updating a RADIUS gateway, you must include all of the parameters that are required when creating a RADIUS gateway, even if you are not modifying their values.
You cannot change the
typeof a gateway in an update call.
Prerequisites
- See Gateway Management for important overview information.
For descriptions of the general parameters in the body of the request, see Gateway base data model.
| Property | Type | Required? |
|---|---|---|
description | String | Optional |
enabled | Boolean | Required |
name | String | Required |
For descriptions of the RADIUS-specific parameters in the body of the request, see Gateway RADIUS data model.
| Property | Type | Required? |
|---|---|---|
davinci.policy.id | String | Required |
defaultSharedSecret | String | Optional |
networkPolicyServer | Object | Optional |
networkPolicyServer.ip | String | Required |
networkPolicyServer.port | Integer | Required |
radiusClients | Object[] | Required |
radiusClients.ip | String[] | Required |
radiusClients.sharedSecret | String[] | Optional |
Request Body
{"name"=>"New RADIUS Gateway", "description"=>"Gateway with updated Davinci flow policy ID", "type"=>"RADIUS", "radiusClients"=>[{"ip"=>"127.0.0.1", "sharedSecret"=>nil}], "defaultSharedSecret"=>"secret", "davinci"=>{"policy"=>{"id"=>"567a3443878d406e3fb22f5307059e0b"}}}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways/c512b7ce-6700-4c3b-a73d-791062165789"},"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/c512b7ce-6700-4c3b-a73d-791062165789/instances"},"credentials":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways/c512b7ce-6700-4c3b-a73d-791062165789/credentials"}},"id":"c512b7ce-6700-4c3b-a73d-791062165789","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"New RADIUS Gateway","description":"Gateway with updated Davinci flow policy ID","type":"RADIUS","enabled":true,"supportedVersions":[{"version":"1.1.1","image":"pingidentity/pingone-radius-gateway:1.1.1","recommended":true,"latest":true},{"version":"1.1.0","image":"pingidentity/pingone-radius-gateway:1.1.0","supportEndsOn":"2024-11-30T00:00:00.000Z","daysUntilSupportEnds":217},{"version":"1.1.0","image":"gcr.io/ping-identity/pingone/pingone-radius-gateway:1.1.0","supportEndsOn":"2024-11-30T00:00:00.000Z","daysUntilSupportEnds":217}],"currentAlerts":[{"category":"No Instances Connected","detail":"No gateway instances are connected. All operations that require access to this gateway will fail.","severity":"ERROR"}],"radiusClients":[{"ip":"127.0.0.1"}],"davinci":{"policy":{"id":"567a3443878d406e3fb22f5307059e0b"}},"defaultSharedSecret":"secret"}