Skip to content

Create host

POST
/connection-profiles/{connectionProfileId}/rules/{connectionProfileRuleId}/hosts

Add new host to connection profile rule

connectionProfileId
required
integer

ID of the connection profile to add rule to

connectionProfileRuleId
required
integer

ID of the connection profile rule to add host to

New connection profile rule host data

NewConnectionProfileRuleHost

Data required to create a new connection profile rule host

object
hostname
required

Rule hostname

string
regularExpression

Optional URL matching regex

string

Successfully created new connection profile rule host, returning it

object
data
ConnectionProfileRuleHost

Object representing a connection profile custom rule host

object
id

Internal connection profile rule host ID

integer
createdAt

Date of rule host creation

date
updatedAt

Date of rule host update (can be null)

date
hostname

Rule hostname

string
regularExpression

Optional URL matching regex

string

401 Authentication failed

401 Authentication failed response

Unable to authenticate user

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

422 Unprocessable entity

422 Unprocessable entity

There is something wrong with the content of the request, typically missing or improperly formatted fields

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string