API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Update existing EST profile configuration

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/est-profiles/

Configurate the parameters of Enrollment over Secure Transport(EST) Profile. You can configure parameters such as server-host, server-port,
arbitrary-label, etc.
For AP, one EST profile is supported for per device.
For CX device, maximum of 16 profiles supported.

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

EST Profile name to be configured.
For AP device, valid length: 1-32 characters.
For CX device, valid length: 1-32 characters.

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

profilebody object

string
length between 1 and 256

Arbitrary Label used in EST enrollment/reenrollment operations.
For AP device, valid length: 1-63 characters.
For CX device, valid length: 1-64 characters.

string
length between 1 and 64

Arbitrary Label used in EST enrollment.
For Gateway device, valid length: 1-63 characters.
For AP device, valid length: 1-63 characters.

string
length between 1 and 64

Arbitrary Label used in EST reenrollment.
For Gateway device, valid length: 1-63 characters.
For AP device, valid length: 1-63 characters.

boolean
Defaults to false

Allows EST CA download

string
length ≤ 9999

Challenge Password used in EST enrollment. This configuration is valid only if
username is not configured.

string
length between 1 and 256

EST client password in ciphertext.

string
enum
Defaults to RSA_SHA256

CSR Attribute used in EST enrollment.
Following values are valid for AP and Gateway devices:

  1. RSA_SHA256: RSA-2048 with SHA256 digest as CSR Attr value.
  2. ECDSA_PRIME256V1_SHA256: ECDSA NIST P-256 with SHA256 digest as CSR Attr value
  3. ECDSA_PRIME384R1_SHA384: ECDSA NIST P-384 with SHA384 digest as CSR Attr value
    Below values are supported only for AP devices:
  4. RSA_SHA384: RSA with SHA384 as CSR Attr value
  5. RSA_SHA512: RSA with SHA512 as CSR Attr value
Show Details
ECDSA_PRIME256V1_SHA256ECDSA NIST P-256 with SHA256 digest as CSR Attr value.
ECDSA_PRIME384R1_SHA384ECDSA NIST P-384 with SHA384 digest as CSR Attr value.
RSA_SHA256RSA-2048 with SHA256 digest as CSR Attr value.
RSA_SHA384RSA with SHA384 as CSR Attr value
RSA_SHA512RSA with SHA512 as CSR Attr value
Allowed:
string
length between 1 and 256

User description for EST Profile.

boolean
Defaults to false

This configuration is used to activate or deactivate EST profile.

boolean
Defaults to false

Enables HTTP-Digest-Auth in EST operation

string
enum
Defaults to KEY_LEN_2048

Length of RSA key used in CSR

Show Details
KEY_LEN_2048RSA Key Length of 2048 bits
KEY_LEN_4096RSA Key Length of 4096 bits
Allowed:
string
length between 1 and 63

EST Profile name to be configured.
For AP device, valid length: 1-32 characters.
For CX device, valid length: 1-32 characters.

string
length between 1 and 63

Organization-Unit used in CSR attribute value.

string
length ≤ 9999

Password of the EST Client. This configuration is valid only if username is configured.
For Gateway device, valid length: 1-63 characters.
For AP device, valid length: 1-63 characters.

int32
0 to 30
Defaults to 2

Number of days prior certificate expiry to initiate reenrollment

int32
0 to 32

Retry-count for EST operations

int32
30 to 600
Defaults to 30

Retry-interval in seconds for EST operations

string
length ≤ 9999

EST Server's CA Cert name.

required
length ≤ 9999

EST Server's hostname/IP address.
For CX device, valid length: 1-162 characters.

int32
1 to 65535
Defaults to 443

Port number for EST server.

string
length ≤ 9999

VRF for EST operation

string
length between 1 and 64

Username of the EST Client.
For Gateway device, valid length: 1-63 characters.
For AP device, valid length: 1-63 characters.
For CX device, valid length: 1-32 characters.

Responses

Updated 11 days ago

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

Updated 11 days ago