A specific Certificate Authority by ID

GET

/

v2.5

/

api

/

pkis

/

{service}

/

certificate-authorities

/

{uid}

cURL

curl -sk -X GET "https://<controller>/v2.5/api/pkis/{service}/certificate-authorities/{uid}" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2.5/api/pkis/{service}/certificate-authorities/{uid}"
headers = {"Authorization": "cid <CID>"}

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

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2.5/api/pkis/{service}/certificate-authorities/{uid}", 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)
}

{
  "certificate_authority_id": "<string>",
  "created_time": 123,
  "display_name": "<string>",
  "id": "<string>",
  "origin": "Unspecified",
  "service": "internal",
  "signing_certificate": "<string>",
  "state": "active"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Headers

Authorization

string

default:cid <CID>

required

Controller ID in the format: cid .

Example:

"cid <CID>"

Path Parameters

service

enum<string>

required

The service to retrieve the CA of

Available options:

internal,

uservpn

uid

string

required

The ID of a ServiceCA from protostore service_certificate_authority to retrieve.

Response

Successfully retrieved Certificate Authority

certificate_authority_id

string

ID of the associated certificate authority

created_time

integer

Creation time as a UNIX timestamp

display_name

string

Display name for the certificate authority

id

string

The ID of the Service CA from protostore service_certificate_authority

origin

enum<string>

Origin of the certificate authority

Available options:

Unspecified,

Aviatrix,

Custom

service

enum<string>

Service using this certificate authority

Available options:

internal,

uservpn

signing_certificate

string

Signing certificate in PEM format

state

enum<string>

Current state of the certificate authority

Available options:

active,

deactivated,

prepared

⌘I

cURL

curl -sk -X GET "https://<controller>/v2.5/api/pkis/{service}/certificate-authorities/{uid}" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2.5/api/pkis/{service}/certificate-authorities/{uid}"
headers = {"Authorization": "cid <CID>"}

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

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2.5/api/pkis/{service}/certificate-authorities/{uid}", 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)
}

{
  "certificate_authority_id": "<string>",
  "created_time": 123,
  "display_name": "<string>",
  "id": "<string>",
  "origin": "Unspecified",
  "service": "internal",
  "signing_certificate": "<string>",
  "state": "active"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}