Skip to main content

Retrieve an FQDN

GET 

/fqdns/:id

Return the details regarding a specific FQDN.

Request

Path Parameters

    id int64required

    Identifies the resource.

Responses

200: Successful response with details about an FQDN connection.

Schema

    data

    object

    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.

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
  • ]

403: The user doesn't have the required permissions to perform the requested action.

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

404: The requested resource doesn't exist.

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

Loading...