Import new HTTPS certs

POST

/

v2

/

api

/

import_new_https_certs

cURL

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

import requests

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

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

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/import_new_https_certs", 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
}

Body

application/json

CID

string

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

action

string

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

ca_cert

string

To import a CA certificate. This field must be base64 encoded.

ca_certs_import

string

To import a CA certificate.

certs_import

string

To import a signed certificate.

certs_import_disable

boolean

Disable an imported signed certificate.

certs_import_req

boolean

To request a CSR to do certs import.

crt_import_phase

boolean

Certificate import operation phases(1,2,3).

download

boolean

Download certificate signing request file.

host_name

string

The host name (FQDN) of Controller UI WebServers.

is_https_certs

enum<string>

Enable|Disable HTTPS certificates.

Available options:

false,

true

private_key

string

To import certificate private key. This field must be base64 encoded.

server_cert

string

To import server certificate. This field must be base64 encoded.

status

boolean

Status of HTTPS Certs enabling/disabling.

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 POST "https://<controller>/v2/api/import_new_https_certs" \
  -H "Authorization: cid <CID>"

import requests

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

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

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/import_new_https_certs", 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
}