API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Update Device Certificate by certificate name.

List of device certificate parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Name of Device Certificate to be configured.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

device-certificatebody object

subject
object

Configuration of Certificate subject parameters.

app-usage
array of strings
length ≤ 2147483647
Show Details
ALLCertificate is assigned for use by all applications.
CAPTIVE_PORTALCertificate is assigned for use by captive-portal application
DOT1X_SUPPLICANTCertificate is assigned for use by Dot1x supplicant application.
EST_CLIENTCertificate is assigned for use by EST client application.
HSCCertificate is assigned for use by hardware switch controller application.
OPENFLOWCertificate is assigned for use by openflow application.
RADSEC_CLIENTCertificate is assigned for use by RADsec client application.
SSH_CLIENTCertificate is assigned for use by ssh-client application.
SSH_SERVERCertificate is assigned for use by ssh-server application.
SYSLOGCertificate is assigned for use by syslog application.
WEBCertificate is assigned for use by web application.
app-usage
string
enum

Configuration of certificate key type to RSA or ECDSA.

Show Details
ECDSAECDSA Key Type
RSARSA Key Type
Allowed:
string
enum

ECDSA Curve Size when certificate key type is ECDSA.

Show Details
CURVE_SIZE_256ECDSA Curve Size of 256 bits
CURVE_SIZE_384ECDSA Curve Size of 384 bits
CURVE_SIZE_521ECDSA Curve Size of 521 bits
Allowed:
string
length ≤ 9999

EST profile to use for Device Certificate enrollment.

ext-key-usage
array of strings
length ≤ 2147483647
Show Details
CLIENT_AUTHExtended Key Usage for Client Authentication.
SERVER_AUTHExtended Key Usage for Server Authentication.
ext-key-usage
key-usage
array of strings
length ≤ 2147483647
Show Details
DATA_ENCIPHERMENTKey Usage for Data Encipherment.
DIGITAL_SIGNATUREKey Usage for Digital Signature.
KEY_AGREEMENTKey Usage for Key Agreement.
KEY_ENCIPHERMENTKey Usage for Key Encipherment.
NON_REPUDIATIONKey Usage for Non-Repudiation.
key-usage
string
enum

Restriction of key on key-agreement usage.

Show Details
KEY_RESTRICTION_DECIPHERRestriction of key as decipher only.
KEY_RESTRICTION_ENCIPHERRestriction of key as encipher only.
Allowed:
string
length between 1 and 32

Name of Device Certificate to be configured.

string
enum

RSA Key Length when certificate key type is RSA.

Show Details
KEY_LEN_1024RSA Key Length of 1024 bits
KEY_LEN_2048RSA Key Length of 2048 bits
KEY_LEN_3072RSA Key Length of 3072 bits
KEY_LEN_4096RSA Key Length of 4096 bits
Allowed:
string
length between 1 and 253

Subject Alternative Name entry containing a DNS name.

length ≤ 9999

Subject Alternative Name entry containing an IP Address.

string
length ≤ 9999

Certificate Validity end date (MM/DD/YYYY).

string
length ≤ 9999

Certificate Validity start date (MM/DD/YYYY).

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json