ON THIS PAGE
GET /config/remote_services/{service_id}
SUMMARY Retrieves a deployed remote service by ID.
Retrieves a deployed remote service by ID.
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 retrieving a deployed remote service. |
fields |
query |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The deployed remote service was successfully retrieved. |
|
404 |
1002 |
No deployed remote service was found with the provided ID. |
500 |
1020 |
An error occurred during the retrieval 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" }