HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. End Entity Profiles

Update an existing End Entity Profile's configuration.

put
http://127.0.0.1:8080/security/endEntityProfiles

Updates an existing End Entity Profile identified by its label. The label field is used to match the profile to update and cannot be changed. All other fields can be modified including CSR attributes, EST server configurations, and certificate subject fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

End Entity Profile configuration with updated values. The label must match an existing profile.

End Entity Profile configuration for certificate enrollment and management.

string
required
length ≤ 64

Unique identifier for the End Entity Profile. Must be unique across all profiles (case-insensitive comparison).

string
enum
required

Defines the certificate usage type. Determines how the certificate will be used by appliances.

Allowed:
string
enum
required

Certificate Signing Request attributes specifying the cryptographic algorithm. Must be compatible with the active Cipher Profile's minimum key lengths.

Allowed:
boolean
Defaults to false

Indicates if EST (Enrollment over Secure Transport) is enabled. Automatically set to true when est_server_profiles contains entries.

est_server_profiles
object

Mapping of EST Server profiles by priority (0-3). Priority 0 is highest. Must have at least one entry if EST is enabled.

string

Domain suffix appended to hostname in certificate subject. Example: hostname 'xyz-ecva' with domain 'test.com' produces 'xyz-ecva.test.com' in subject.

string

Domain suffix appended to hostname in certificate SAN (Subject Alternative Name) DNS field.

string

Interface label whose IP address will be added to certificate SAN. Must match a configured interface label (e.g., MPLS1, INET1).

string

Domain suffix appended to hostname for email (RFC822) field in certificate SAN. Example: hostname 'xyz-ecva' with domain 'test.com' produces '[email protected]'.

string

Organization name (O) field for the certificate subject DN.

string

Organizational Unit name (OU) field for the certificate subject DN.

boolean
Defaults to false

When true, includes the appliance serial number in the certificate subject DN.

integer
50 to 90
Defaults to 75

Percentage of certificate lifetime at which automatic re-enrollment is triggered. Example: 75% on a 100-day certificate triggers re-enrollment on day 75.

Responses

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain

Updated about 11 hours ago

Did this page help you?