GET /staged_config/remote_services

Retrieves a list of staged remote services.

Retrieves the list of staged remote services

Table 1. GET /staged_config/remote_services resource details
MIME Type

application/json

Table 2. GET /staged_config/remote_services request parameter details
Parameter Type Optionality Data Type MIME Type Description

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

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.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

Table 3. GET /staged_config/remote_services response codes
HTTP Response Code Unique Code Description

200

The staged remote services list was successfully retrieved.

500

1020

An internal server error occurred during the retrieval of the list of staged remote services.

Response Description

A list of staged remote services.
  • 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"
    }
]