Copilot association status

GET

/

v2

/

api

/

get_copilot_association_status

cURL

curl -sk -X GET "https://<controller>/v2/api/get_copilot_association_status" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/get_copilot_association_status"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/get_copilot_association_status", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Query Parameters

copilot_ip

string

.

public_ip

string

.

copilot_fqdn

string

Optional CoPilot FQDN association metadata; must be ASCII and a valid hostname or IP when provided.

cloud_type

string

Cloud-Service-Provider type which is represented by 1/2/4/8/16 etc...

account_number

string

Account number created from setup_account_profile.

vpc_region

string

The region of an existing vpc you wish to connect.

security_group_id

string

.

instance_id

string

Instance id for current controller.

vpc_id

string

The vpc id of an existing L3 vpc you wish to connect.

subnet_id

string

The subnet ID of an existing L3 subnet you wish to connect.

instance_size

string

Instance size of vpc cloudx.

data_volume_size

string

Data volume size for copilot in gigabytes, and the default size is 100G.

action

string

The API action to perform. Required for 7.2 controllers only.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

⌘I

cURL

curl -sk -X GET "https://<controller>/v2/api/get_copilot_association_status" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/get_copilot_association_status"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/get_copilot_association_status", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}