ON THIS PAGE
POST /staged_config/remote_services
SUMMARY Adds a staged remote service.
Creates a staged remote service.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
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 |
The new remote service object. |
{ "cidrs": [ "String" ], "description": "String", "group": "String", "id": 42, "name": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
201 |
The new staged remote service was successfully created. |
|
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 creation 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" }