A specific DCF TLS profile by UUID

GET

/

v2.5

/

api

/

dcf

/

tls-profile

/

{profile_uuid}

cURL

curl -sk -X GET "https://<controller>/v2.5/api/dcf/tls-profile/{profile_uuid}" \
  -H "Authorization: cid <CID>"

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2.5/api/dcf/tls-profile/{profile_uuid}", 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)
}

{
  "ca_bundle_id": "a1b2c3d4-58cc-4372-a567-0e02b2c3d479",
  "certificate_validation": "CERTIFICATE_VALIDATION_ENFORCE",
  "display_name": "Production TLS Profile",
  "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "verify_sni": true
}

{
  "message": "TLS profile with UUID 'f47ac10b-58cc-4372-a567-0e02b2c3d479' not found"
}

{
  "message": "TLS profile with display name 'Production TLS Profile' already exists"
}

{
  "message": "Invalid TLS profile configuration"
}

{
  "message": "<string>"
}

Headers

Authorization

string

default:cid <CID>

required

Controller ID in the format: cid .

Example:

"cid <CID>"

Path Parameters

profile_uuid

string<uuid>

required

The UUID of the TLS profile to retrieve

Response

TLS profile retrieved successfully

certificate_validation

enum<string>

required

Certificate validation mode

Available options:

CERTIFICATE_VALIDATION_NONE,

CERTIFICATE_VALIDATION_LOG_ONLY,

CERTIFICATE_VALIDATION_ENFORCE

display_name

string

required

Display name for the TLS profile

uuid

string

required

The unique identifier for the TLS profile

verify_sni

boolean

required

Toggle to enable advanced SNI verification of client

CA_bundle_id

string

UUID of the CA bundle that should be used for origin certificate validation. If not populated the default bundle would be used.

origin_cert_expiration

enum<string>

Controls behavior when an origin certificate has expired

Available options:

ORIGIN_CERT_EXPIRATION_UNSPECIFIED,

ORIGIN_CERT_EXPIRATION_LOG_ONLY,

ORIGIN_CERT_EXPIRATION_ENFORCE

⌘I

cURL

curl -sk -X GET "https://<controller>/v2.5/api/dcf/tls-profile/{profile_uuid}" \
  -H "Authorization: cid <CID>"

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2.5/api/dcf/tls-profile/{profile_uuid}", 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)
}

{
  "ca_bundle_id": "a1b2c3d4-58cc-4372-a567-0e02b2c3d479",
  "certificate_validation": "CERTIFICATE_VALIDATION_ENFORCE",
  "display_name": "Production TLS Profile",
  "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "verify_sni": true
}

{
  "message": "TLS profile with UUID 'f47ac10b-58cc-4372-a567-0e02b2c3d479' not found"
}

{
  "message": "TLS profile with display name 'Production TLS Profile' already exists"
}

{
  "message": "Invalid TLS profile configuration"
}

{
  "message": "<string>"
}