Skip to content
RallyHere Docs

Get All Custom Endpoints For Sandbox

GET
/v1/sandbox/{sandbox_id}/custom-endpoint

Get all Custom Endpoints for Sandbox, requires sandbox:config:view | sandbox:config:edit permission

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

page_size

The maximum number of elements to be returned per call

integer
default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

Responses

200

Successful Response

object
custom_endpoints

A list of custom endpoints

Array<object>
default:

This mixin is meant to give a set of common properties to root config models

object
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when the resource was created

string format: date-time
sandbox_id

ID of the Sandbox

string format: uuid
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
custom_endpoint_unique_id

Unique identifier for this custom endpoint

string format: uuid
endpoint_id
required

The customer defined identifier for this endpoint

string
>= 1 characters
url
required

User friendly identifier of setting type

string
>= 1 characters
http_verb

HTTP verb to use when calling the custom endpoint

string
Allowed values: GET POST PUT DELETE HEAD PATCH
custom_headers

Custom headers to be passed to the endpoint

object
key
additional properties
string
cursor
required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
>= 1 characters <= 128 characters

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string