Skip to content

List hosts

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

Get hosts by connection profile rule

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
connectionProfileId
required
integer

ID of the connection profile

connectionProfileRuleId
required
integer

ID of the connection profile rule

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successfully retrieved connection profile rule hosts

object
meta
object
pagination
Pagination section

Contains page and count information for lists

object
count

Number of items returned in this response

integer
totalCount

Total number of items in collection

integer
page

Current page

integer
totalPages

Total number of pages in collection

integer
data
Array<object>
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

Section titled “401 ”

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

403

Section titled “403 ”

403 Forbidden

403 Forbidden response

Currently authenticated user does not have permission to access or update requested object

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

404

Section titled “404 ”

404 Not found

404 Not found response

Requested resource or underlying resource was not found

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

Section titled “422 ”

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