Retrieve a Global IP

GET 
/global_ip_assignments/:id

Retrieve a Global IP assignment.

Request

Path Parameters

id uuidrequired

Identifies the resource.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

Identifies the resource.

record_type string

Identifies the type of the resource.

created_at string

ISO 8601 formatted date-time indicating when the resource was created.

updated_at string

ISO 8601 formatted date-time indicating when the resource was updated.

global_ip_id uuid

Global IP ID.

wireguard_peer_id uuid

Wireguard peer ID.

status InterfaceStatus (string)

Possible values: [created, provisioning, provisioned, deleting]

The current status of the interface deployment.

is_connected boolean

Wireguard peer is connected.

is_in_maintenance boolean

Enable/disable BGP announcement.

is_announced boolean

Status of BGP announcement.

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": true,
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
    "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
    "status": "provisioned",
    "is_connected": true,
    "is_in_maintenance": true,
    "is_announced": true
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...