Skip to content

Create Custom Endpoint

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

Create Custom Endpoint, requires sandbox:config:edit permission

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Request Body required

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

object
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
default: 0c90ed27-b0e7-4f8c-a678-e59192e6eb29
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

Responses

201

Successful Response

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
default: 0c90ed27-b0e7-4f8c-a678-e59192e6eb29
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

422

Validation Error

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