Skip to main content

List FQDNs

GET 

/fqdns

Get all FQDNs belonging to the user that match the given filters.

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 250

    The size of the page

    filter[connection_id] string

    ID of the FQDN connection to which the FQDN belongs.

    filter[fqdn] string

    FQDN represented by the resource.

    filter[port] integer

    Port to use when connecting to the FQDN.

    filter[dns_record_type] string

    DNS record type used by the FQDN.

Responses

200: Successful response with a list of FQDN connections.

Schema

    data

    object[]

  • Array [

  • id int64

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    connection_id string

    ID of the FQDN connection to which this FQDN is attached.

    fqdn string

    FQDN represented by this resource.

    port integer

    Default value: 5060

    Port to use when connecting to this FQDN.

    dns_record_type string

    The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.

    created_at string

    ISO 8601 formatted date indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

  • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

400: Bad request, the request was unacceptable, often due to missing a required parameter.

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

401: Unauthorized

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

Loading...