Avi PKIProfile Object API

CLI ``` - configure pkiprofile - show pkiprofile ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 22.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /pkiprofile
  2. post /pkiprofile
  3. delete /pkiprofile/{uuid}
  4. get /pkiprofile/{uuid}/federated_info/
  5. get /pkiprofile/{uuid}
  6. patch /pkiprofile/{uuid}
  7. put /pkiprofile/{uuid}
Up
get /pkiprofile
(pkiprofileGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

PKIProfileApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "ca_certs" : [ {
      "public_key" : "aeiou",
      "certificate_signing_request" : "aeiou",
      "signature" : "aeiou",
      "not_before" : "aeiou",
      "subject" : "",
      "certificate" : "aeiou",
      "serial_number" : "aeiou",
      "version" : "aeiou",
      "issuer" : {
        "country" : "aeiou",
        "email_address" : "aeiou",
        "organization" : "aeiou",
        "distinguished_name" : "aeiou",
        "locality" : "aeiou",
        "state" : "aeiou",
        "common_name" : "aeiou",
        "organization_unit" : "aeiou"
      },
      "not_after" : "aeiou",
      "days_until_expire" : 123,
      "expiry_status" : "aeiou",
      "subject_alt_names" : [ "aeiou" ],
      "chain_verified" : true,
      "fingerprint" : "aeiou",
      "signature_algorithm" : "aeiou",
      "text" : "aeiou",
      "key_params" : {
        "ec_params" : {
          "curve" : "aeiou"
        },
        "rsa_params" : {
          "exponent" : 123,
          "key_size" : "aeiou"
        },
        "algorithm" : "aeiou"
      },
      "self_signed" : true
    } ],
    "ignore_peer_chain" : true,
    "created_by" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "validate_only_leaf_crl" : true,
    "tenant_ref" : "aeiou",
    "crl_check" : true,
    "crls" : [ {
      "update_interval" : 123,
      "last_update" : "aeiou",
      "distinguished_name" : "aeiou",
      "fingerprint" : "aeiou",
      "etag" : "aeiou",
      "text" : "aeiou",
      "body" : "aeiou",
      "common_name" : "aeiou",
      "server_url" : "aeiou",
      "last_refreshed" : "aeiou",
      "next_update" : "aeiou"
    } ],
    "name" : "aeiou",
    "configpb_attributes" : {
      "version" : 123
    },
    "markers" : [ {
      "values" : [ "aeiou" ],
      "key" : "aeiou"
    } ],
    "is_federated" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKIProfileApiResponse

401

log in failed

Up
post /pkiprofile
(pkiprofilePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — PKIProfile object creation

Return type

PKIProfile

Example data

Content-Type: application/json
{
  "ca_certs" : [ {
    "public_key" : "aeiou",
    "certificate_signing_request" : "aeiou",
    "signature" : "aeiou",
    "not_before" : "aeiou",
    "subject" : "",
    "certificate" : "aeiou",
    "serial_number" : "aeiou",
    "version" : "aeiou",
    "issuer" : {
      "country" : "aeiou",
      "email_address" : "aeiou",
      "organization" : "aeiou",
      "distinguished_name" : "aeiou",
      "locality" : "aeiou",
      "state" : "aeiou",
      "common_name" : "aeiou",
      "organization_unit" : "aeiou"
    },
    "not_after" : "aeiou",
    "days_until_expire" : 123,
    "expiry_status" : "aeiou",
    "subject_alt_names" : [ "aeiou" ],
    "chain_verified" : true,
    "fingerprint" : "aeiou",
    "signature_algorithm" : "aeiou",
    "text" : "aeiou",
    "key_params" : {
      "ec_params" : {
        "curve" : "aeiou"
      },
      "rsa_params" : {
        "exponent" : 123,
        "key_size" : "aeiou"
      },
      "algorithm" : "aeiou"
    },
    "self_signed" : true
  } ],
  "ignore_peer_chain" : true,
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "validate_only_leaf_crl" : true,
  "tenant_ref" : "aeiou",
  "crl_check" : true,
  "crls" : [ {
    "update_interval" : 123,
    "last_update" : "aeiou",
    "distinguished_name" : "aeiou",
    "fingerprint" : "aeiou",
    "etag" : "aeiou",
    "text" : "aeiou",
    "body" : "aeiou",
    "common_name" : "aeiou",
    "server_url" : "aeiou",
    "last_refreshed" : "aeiou",
    "next_update" : "aeiou"
  } ],
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKIProfile

401

log in failed

Up
delete /pkiprofile/{uuid}
(pkiprofileUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /pkiprofile/{uuid}/federated_info/
(pkiprofileUuidFederatedInfoGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
get /pkiprofile/{uuid}
(pkiprofileUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

PKIProfile

Example data

Content-Type: application/json
{
  "ca_certs" : [ {
    "public_key" : "aeiou",
    "certificate_signing_request" : "aeiou",
    "signature" : "aeiou",
    "not_before" : "aeiou",
    "subject" : "",
    "certificate" : "aeiou",
    "serial_number" : "aeiou",
    "version" : "aeiou",
    "issuer" : {
      "country" : "aeiou",
      "email_address" : "aeiou",
      "organization" : "aeiou",
      "distinguished_name" : "aeiou",
      "locality" : "aeiou",
      "state" : "aeiou",
      "common_name" : "aeiou",
      "organization_unit" : "aeiou"
    },
    "not_after" : "aeiou",
    "days_until_expire" : 123,
    "expiry_status" : "aeiou",
    "subject_alt_names" : [ "aeiou" ],
    "chain_verified" : true,
    "fingerprint" : "aeiou",
    "signature_algorithm" : "aeiou",
    "text" : "aeiou",
    "key_params" : {
      "ec_params" : {
        "curve" : "aeiou"
      },
      "rsa_params" : {
        "exponent" : 123,
        "key_size" : "aeiou"
      },
      "algorithm" : "aeiou"
    },
    "self_signed" : true
  } ],
  "ignore_peer_chain" : true,
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "validate_only_leaf_crl" : true,
  "tenant_ref" : "aeiou",
  "crl_check" : true,
  "crls" : [ {
    "update_interval" : 123,
    "last_update" : "aeiou",
    "distinguished_name" : "aeiou",
    "fingerprint" : "aeiou",
    "etag" : "aeiou",
    "text" : "aeiou",
    "body" : "aeiou",
    "common_name" : "aeiou",
    "server_url" : "aeiou",
    "last_refreshed" : "aeiou",
    "next_update" : "aeiou"
  } ],
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKIProfile

401

log in failed

Up
patch /pkiprofile/{uuid}
(pkiprofileUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — PKIProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

PKIProfile

Example data

Content-Type: application/json
{
  "ca_certs" : [ {
    "public_key" : "aeiou",
    "certificate_signing_request" : "aeiou",
    "signature" : "aeiou",
    "not_before" : "aeiou",
    "subject" : "",
    "certificate" : "aeiou",
    "serial_number" : "aeiou",
    "version" : "aeiou",
    "issuer" : {
      "country" : "aeiou",
      "email_address" : "aeiou",
      "organization" : "aeiou",
      "distinguished_name" : "aeiou",
      "locality" : "aeiou",
      "state" : "aeiou",
      "common_name" : "aeiou",
      "organization_unit" : "aeiou"
    },
    "not_after" : "aeiou",
    "days_until_expire" : 123,
    "expiry_status" : "aeiou",
    "subject_alt_names" : [ "aeiou" ],
    "chain_verified" : true,
    "fingerprint" : "aeiou",
    "signature_algorithm" : "aeiou",
    "text" : "aeiou",
    "key_params" : {
      "ec_params" : {
        "curve" : "aeiou"
      },
      "rsa_params" : {
        "exponent" : 123,
        "key_size" : "aeiou"
      },
      "algorithm" : "aeiou"
    },
    "self_signed" : true
  } ],
  "ignore_peer_chain" : true,
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "validate_only_leaf_crl" : true,
  "tenant_ref" : "aeiou",
  "crl_check" : true,
  "crls" : [ {
    "update_interval" : 123,
    "last_update" : "aeiou",
    "distinguished_name" : "aeiou",
    "fingerprint" : "aeiou",
    "etag" : "aeiou",
    "text" : "aeiou",
    "body" : "aeiou",
    "common_name" : "aeiou",
    "server_url" : "aeiou",
    "last_refreshed" : "aeiou",
    "next_update" : "aeiou"
  } ],
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKIProfile

401

log in failed

Up
put /pkiprofile/{uuid}
(pkiprofileUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — PKIProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

PKIProfile

Example data

Content-Type: application/json
{
  "ca_certs" : [ {
    "public_key" : "aeiou",
    "certificate_signing_request" : "aeiou",
    "signature" : "aeiou",
    "not_before" : "aeiou",
    "subject" : "",
    "certificate" : "aeiou",
    "serial_number" : "aeiou",
    "version" : "aeiou",
    "issuer" : {
      "country" : "aeiou",
      "email_address" : "aeiou",
      "organization" : "aeiou",
      "distinguished_name" : "aeiou",
      "locality" : "aeiou",
      "state" : "aeiou",
      "common_name" : "aeiou",
      "organization_unit" : "aeiou"
    },
    "not_after" : "aeiou",
    "days_until_expire" : 123,
    "expiry_status" : "aeiou",
    "subject_alt_names" : [ "aeiou" ],
    "chain_verified" : true,
    "fingerprint" : "aeiou",
    "signature_algorithm" : "aeiou",
    "text" : "aeiou",
    "key_params" : {
      "ec_params" : {
        "curve" : "aeiou"
      },
      "rsa_params" : {
        "exponent" : 123,
        "key_size" : "aeiou"
      },
      "algorithm" : "aeiou"
    },
    "self_signed" : true
  } ],
  "ignore_peer_chain" : true,
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "validate_only_leaf_crl" : true,
  "tenant_ref" : "aeiou",
  "crl_check" : true,
  "crls" : [ {
    "update_interval" : 123,
    "last_update" : "aeiou",
    "distinguished_name" : "aeiou",
    "fingerprint" : "aeiou",
    "etag" : "aeiou",
    "text" : "aeiou",
    "body" : "aeiou",
    "common_name" : "aeiou",
    "server_url" : "aeiou",
    "last_refreshed" : "aeiou",
    "next_update" : "aeiou"
  } ],
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PKIProfile

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. CRL
  2. ConfigPbAttributes
  3. KeyValue
  4. PKIProfile
  5. PKIProfileApiResponse
  6. RoleFilterMatchLabel
  7. SSLCertificate
  8. SSLCertificateDescription
  9. SSLKeyECParams
  10. SSLKeyParams
  11. SSLKeyRSAParams

CRL Up

body (optional)
String Certificate Revocation list from a given issuer in PEM format. This can either be configured directly or via the server_url. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
common_name (optional)
String Common name of the issuer in the Certificate Revocation list. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
distinguished_name (optional)
String Distinguished name of the issuer in the Certificate Revocation list. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
etag (optional)
String Cached etag to optimize the download of the CRL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fingerprint (optional)
String Fingerprint of the CRL. Used to avoid configuring duplicates. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
last_refreshed (optional)
String Last time CRL was refreshed by the system. This is an internal field used by the system. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
last_update (optional)
String The date when this CRL was last issued. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
next_update (optional)
String The date when a newer CRL will be available. Also conveys the date after which the CRL should be considered obsolete. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_url (optional)
String URL of a server that issues the Certificate Revocation list. If this is configured, CRL will be periodically downloaded either based on the configured update interval or the next update interval in the CRL. CRL itself is stored in the body. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
text (optional)
String Certificate Revocation list in plain text for readability. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
update_interval (optional)
Integer Interval in minutes to check for CRL update. If not specified, interval will be 1 day. Allowed values are 30-525600. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

KeyValue Up

key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PKIProfile Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
ca_certs (optional)
array[SSLCertificate] List of Certificate Authorities (Root and Intermediate) trusted that is used for certificate validation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
created_by (optional)
String Creator name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
crl_check (optional)
Boolean When enabled, Avi will verify via CRL checks that certificates in the trust chain have not been revoked. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
crls (optional)
array[CRL] Certificate Revocation Lists. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ignore_peer_chain (optional)
Boolean When enabled, Avi will not trust Intermediate and Root certs presented by a client. Instead, only the chain certs configured in the Certificate Authority section will be used to verify trust of the client's cert. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition. Special default for Essentials edition is true, Basic edition is true, Enterprise is False.
is_federated (optional)
Boolean This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
name
String Name of the PKI Profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
validate_only_leaf_crl (optional)
Boolean When enabled, Avi will only validate the revocation status of the leaf certificate using CRL. To enable validation for the entire chain, disable this option and provide all the relevant CRLs. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

PKIProfileApiResponse Up

count
Integer format: int32
results
next (optional)

RoleFilterMatchLabel Up

key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

SSLCertificate Up

certificate (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
certificate_signing_request (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
chain_verified (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
days_until_expire (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
expiry_status (optional)
String Enum options - SSL_CERTIFICATE_GOOD, SSL_CERTIFICATE_EXPIRY_WARNING, SSL_CERTIFICATE_EXPIRED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
fingerprint (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
issuer (optional)
SSLCertificateDescription Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key_params (optional)
SSLKeyParams Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
not_after (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
not_before (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
public_key (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
self_signed (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serial_number (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
signature (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
signature_algorithm (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subject (optional)
SSLCertificateDescription Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
subject_alt_names (optional)
array[String] subjectAltName that provides additional subject identities. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
text (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
version (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SSLCertificateDescription Up

common_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
country (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
distinguished_name (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
email_address (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
locality (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
organization (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
organization_unit (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
state (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SSLKeyECParams Up

curve (optional)
String Enum options - SSL_KEY_EC_CURVE_SECP256R1, SSL_KEY_EC_CURVE_SECP384R1, SSL_KEY_EC_CURVE_SECP521R1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SSLKeyParams Up

algorithm
String Enum options - SSL_KEY_ALGORITHM_RSA, SSL_KEY_ALGORITHM_EC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ec_params (optional)
SSLKeyECParams Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
rsa_params (optional)
SSLKeyRSAParams Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SSLKeyRSAParams Up

exponent (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
key_size (optional)
String Enum options - SSL_KEY_1024_BITS, SSL_KEY_2048_BITS, SSL_KEY_3072_BITS, SSL_KEY_4096_BITS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.