v1/endentity

Edits end entity setting new status

Changed on Mar 11, 2025

Edit status, password and token type of related end entity

post/v1/endentity/{endentity_name}/setstatus

Request

Base URL
/ejbca/ejbca-rest-api (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/keyfactor/apis/ejbca-rest-interface/docs/v1/endentity/:endentity_name/setstatus/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

endentity_namestring required

Name of the end entity to edit status for

Request body

passwordstring

Password

token'USERGENERATED, P12, BCFKS, JKS, PEM'

Token type property

status'NEW, FAILED, INITIALIZED, INPROCESS, GENERATED, REVOKED, HISTORICAL, KEYRECOVERY, WAITINGFORADDAPPROVAL'

End entity status property

Example request

{
  "password": "foo123",
  "token": "USERGENERATED",
  "status": "NEW"
}

Response

Successful operation

Changes

Mar 11, 20254045b1bab09f Revision changes
- breaking
  removed the enum value BCFKS of the request property
- breaking
  removed the enum value FAILED of the request property
- breaking
  removed the enum value GENERATED of the request property
- breaking
  removed the enum value HISTORICAL of the request property
- breaking
  removed the enum value INITIALIZED of the request property
- breaking
  removed the enum value INPROCESS of the request property
- breaking
  removed the enum value JKS of the request property
- breaking
  removed the enum value KEYRECOVERY of the request property
- breaking
  removed the enum value NEW of the request property
- breaking
  removed the enum value P12 of the request property
- breaking
  removed the enum value PEM of the request property
- breaking
  removed the enum value REVOKED of the request property
- breaking
  removed the enum value USERGENERATED of the request property
- breaking
  removed the enum value WAITINGFORADDAPPROVAL of the request property
- info
  added the new NEW FAILED INITIALIZED INPROCESS GENERATED REVOKED HISTORICAL KEYRECOVERY WAITINGFORADDAPPROVAL enum value to the request property
- info
  added the new USERGENERATED P12 BCFKS JKS PEM enum value to the request property
- info
  added the success response with the status
Mar 11, 202537878df36b77 Revision changes
- breaking
  removed the enum value NEW FAILED INITIALIZED INPROCESS GENERATED REVOKED HISTORICAL KEYRECOVERY WAITINGFORADDAPPROVAL of the request property
- breaking
  removed the enum value USERGENERATED P12 BCFKS JKS PEM of the request property
- breaking
  removed the success response with the status
- info
  added the new BCFKS enum value to the request property
- info
  added the new FAILED enum value to the request property
- info
  added the new GENERATED enum value to the request property
- info
  added the new HISTORICAL enum value to the request property
- info
  added the new INITIALIZED enum value to the request property
- info
  added the new INPROCESS enum value to the request property
- info
  added the new JKS enum value to the request property
- info
  added the new KEYRECOVERY enum value to the request property
- info
  added the new NEW enum value to the request property
- info
  added the new P12 enum value to the request property
- info
  added the new PEM enum value to the request property
- info
  added the new REVOKED enum value to the request property
- info
  added the new USERGENERATED enum value to the request property
- info
  added the new WAITINGFORADDAPPROVAL enum value to the request property

Operation history (4 revisions)