Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /staged_config/remote_services

 

Adds a staged remote service.

Creates a staged remote service.

Table 1: POST /staged_config/remote_services Resource Details

MIME Type

application/json

Table 2: POST /staged_config/remote_services Request Parameter Details

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.

Table 3: POST /staged_config/remote_services Request Body Details

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" }

Table 4: POST /staged_config/remote_services Response Codes

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

The associated new created staged 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