ON THIS PAGE
POST /staged_config/remote_services/{service_id}
SUMMARY Updates an existing staged remote service.
Updates an existing staged remote service.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
service_id |
path |
Required |
Number (Integer) |
text/plain |
ID that is used for updating a staged remote service. |
fields |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
service |
Object |
application/json |
null |
{ "cidrs": [ "String" ], "description": "String", "group": "String", "id": 42, "name": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The staged remote service was successfully updated. |
|
404 |
1002 |
No staged remote service was found for the provided service ID. |
409 |
1008 |
The remote service name already exists in the selected group. |
422 |
1005 |
A request parameter is invalid. |
500 |
1020 |
An error occurred during the update of the remote service. |
Response Description
- id - Long - The ID of the remote service.
- name - String - The name of the remote service.
- description - String - The description of the remote service.
- group - String - The group the remote service belongs to.
- cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote service.
Response Sample
{ "cidrs": [ "String" ], "description": "String", "group": "String", "id": 42, "name": "String" }