HTTPS certs status

GET

/

v2

/

api

/

get_https_certs_status

cURL

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

import requests

url = "https://<controller>/v2/api/get_https_certs_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_https_certs_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

is_https_certs

enum<string>

Enable|Disable HTTPS certificates.

Available options:

false,

true

status

boolean

Status of HTTPS Certs enabling/disabling.

certs_import_req

boolean

To request a CSR to do certs import.

certs_import

string

To import a signed certificate.

ca_certs_import

string

To import a CA certificate.

host_name

string

The host name (FQDN) of Controller UI WebServers.

download

boolean

Download certificate signing request file.

certs_import_disable

boolean

Disable an imported signed certificate.

ca_certificate_import

string

To import a CA certificate.

server_certificate_import

string

To import server certificate.

certificate_privkey_import

string

To import certificate private key.

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_https_certs_status" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/get_https_certs_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_https_certs_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
}