Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/remote_services/{service_id}

Retrieves a deployed remote service by ID.

Retrieves a deployed remote service by ID.

Table 1: GET /config/remote_services/{service_id} Resource Details

MIME Type

application/json

Table 2: GET /config/remote_services/{service_id} Request Parameter Details

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.

Table 3: GET /config/remote_services/{service_id} Response Codes

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

The associated deployed remote service object.

  • 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