Documentation | CodeSign Secure

Method	Endpoint	Description
GET	/project_manage/ApprovalDetailsByEnvId/{env_id}/	List approval policy for an environment
POST	/project_manage/ApprovalDetailsByEnvId/{env_id}/	Add an approval level to an environment
GET	/project_manage/ApprovalDetailsByEnvMappingId/{env_cert_mapping_id}/	List approval policy for a mapping
POST	/project_manage/ApprovalDetailsByEnvMappingId/{env_cert_mapping_id}/	Add an approval level to a mapping
GET	/project_manage/approval/	List approval policies
POST	/project_manage/approval/	Create an approval policy
GET	/project_manage/approval/{id}/	Get an approval policy
PUT	/project_manage/approval/{id}/	Replace an approval policy
PATCH	/project_manage/approval/{id}/	Update an approval policy
GET	/project_manage/approver_master/	List approver types
POST	/project_manage/approver_master/	Create an approver type
GET	/project_manage/approver_master/{id}/	Get an approver type
PUT	/project_manage/approver_master/{id}/	Replace an approver type
PATCH	/project_manage/approver_master/{id}/	Update an approver type
GET	/project_manage/approver_options/	List selectable approvers
POST	/project_manage/approver_options/	Filter selectable approvers
GET	/project_manage/basic/	List applications
POST	/project_manage/basic/	Create an application
GET	/project_manage/basic/{id}/	Get an application
PUT	/project_manage/basic/{id}/	Replace an application
PATCH	/project_manage/basic/{id}/	Update an application
GET	/project_manage/create_certificate/	List certificates for an application
POST	/project_manage/create_certificate/	Attach a certificate to an application
GET	/project_manage/create_certificate/{project_id}/	List certificates for one application
POST	/project_manage/create_certificate/{project_id}/	Attach a certificate to one application
GET	/project_manage/create_certificates/	List certificates available to teams
POST	/project_manage/create_certificates/	Register a certificate for team assignment
GET	/project_manage/create_certificates/{id}/	List a certificate's teams
GET	/project_manage/create_certificates/{id}/teams/	List team assignments for a certificate
POST	/project_manage/create_environment/	Create an environment with its policy
PUT	/project_manage/create_environment/{env_id}/	Update an environment and its policy
GET	/project_manage/environment/	List environments
POST	/project_manage/environment/	Create an environment
GET	/project_manage/environment/{id}/	Get an environment
PUT	/project_manage/environment/{id}/	Replace an environment
PATCH	/project_manage/environment/{id}/	Update an environment
GET	/project_manage/environment_details/	List environments with their policy
GET	/project_manage/environment_details/{env_id}/	Get an environment with its policy
GET	/project_manage/environment_names/	List environment names
GET	/project_manage/manage_environment/	List environments for management
GET	/project_manage/manage_environment/delete/{env_id}/	Get an environment before removal
GET	/project_manage/project_certificate_mapping/	List certificate-to-application mappings
POST	/project_manage/project_certificate_mapping/	Map a certificate to an application
GET	/project_manage/project_certificate_mapping/{id}/	Get a certificate mapping
PUT	/project_manage/project_certificate_mapping/{id}/	Replace a certificate mapping
PATCH	/project_manage/project_certificate_mapping/{id}/	Update a certificate mapping
GET	/project_manage/teams/	List teams
POST	/project_manage/teams/	Create a team
GET	/project_manage/teams/{id}/	Get a team
PUT	/project_manage/teams/{id}/	Replace a team
PATCH	/project_manage/teams/{id}/	Update a team
POST	/project_manage/update_certificate_teams/	Set which teams hold a certificate

GET /project_manage/ApprovalDetailsByEnvId/{env_id}/

Returns the approval levels and approvers configured for one environment.

Request Parameters

Name	Located In	Type	Required	Description
env_id	Path	integer	Yes	Identifier of the environment.

Example Request

curl -X GET "https://<your domain>/api/project_manage/ApprovalDetailsByEnvId/<env_id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/ApprovalDetailsByEnvId/{env_id}/

Adds an approval level for one environment.

Request Parameters

Name	Located In	Type	Required	Description
env_id	Path	integer	Yes	Identifier of the environment.

Request Body (application/json)

Field	Type	Required	Description
quorumUsers	array of object	Yes
level	integer	No	Level
min_count	integer	No	Min count
env_cert_mapping_id	integer	No	Env cert mapping id
env_id	integer	Yes	Env id
ApproverTypeID	integer	Yes	ApproverTypeID

Example Request

curl -X POST "https://<your domain>/api/project_manage/ApprovalDetailsByEnvId/<env_id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"quorumUsers":[],"env_id":1,"ApproverTypeID":1}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/ApprovalDetailsByEnvMappingId/{env_cert_mapping_id}/

Returns the approval levels and approvers for one certificate-and-environment mapping.

Request Parameters

Name	Located In	Type	Required	Description
env_cert_mapping_id	Path	integer	Yes	Identifier of the mapping.

Example Request

curl -X GET "https://<your domain>/api/project_manage/ApprovalDetailsByEnvMappingId/<env_cert_mapping_id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/ApprovalDetailsByEnvMappingId/{env_cert_mapping_id}/

Adds an approval level for one certificate-and-environment mapping.

Request Parameters

Name	Located In	Type	Required	Description
env_cert_mapping_id	Path	integer	Yes	Identifier of the mapping.

Request Body (application/json)

Field	Type	Required	Description
quorumUsers	array of object	Yes
level	integer	No	Level
min_count	integer	No	Min count
env_cert_mapping_id	integer	No	Env cert mapping id
env_id	integer	Yes	Env id
ApproverTypeID	integer	Yes	ApproverTypeID

Example Request

curl -X POST "https://<your domain>/api/project_manage/ApprovalDetailsByEnvMappingId/<env_cert_mapping_id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"quorumUsers":[],"env_id":1,"ApproverTypeID":1}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/approval/

Returns the approval policies configured for each environment, including how many approvals are required.

Example Request

curl -X GET "https://<your domain>/api/project_manage/approval/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/approval/

Defines how signing requests in an environment are approved.

Request Body (application/json)

Field	Type	Required	Description
quorumUsers	array of object	Yes
level	integer	No	Level
min_count	integer	No	Min count
env_cert_mapping_id	integer	No	Env cert mapping id
env_id	integer	Yes	Env id
ApproverTypeID	integer	Yes	ApproverTypeID

Example Request

curl -X POST "https://<your domain>/api/project_manage/approval/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"quorumUsers":[],"env_id":1,"ApproverTypeID":1}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/approval/{id}/

Returns one approval policy by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Example Request

curl -X GET "https://<your domain>/api/project_manage/approval/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /project_manage/approval/{id}/

Replaces a policy. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Request Body (application/json)

Field	Type	Required	Description
quorumUsers	array of object	Yes
level	integer	No	Level
min_count	integer	No	Min count
env_cert_mapping_id	integer	No	Env cert mapping id
env_id	integer	Yes	Env id
ApproverTypeID	integer	Yes	ApproverTypeID

Example Request

curl -X PUT "https://<your domain>/api/project_manage/approval/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"quorumUsers":[],"env_id":1,"ApproverTypeID":1}'

Responses

Status Code	Description
200	The record after the update.

PATCH /project_manage/approval/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Request Body (application/json)

Field	Type	Required	Description
quorumUsers	array of object	Yes
level	integer	No	Level
min_count	integer	No	Min count
env_cert_mapping_id	integer	No	Env cert mapping id
env_id	integer	Yes	Env id
ApproverTypeID	integer	Yes	ApproverTypeID

Example Request

curl -X PATCH "https://<your domain>/api/project_manage/approval/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"quorumUsers":[],"env_id":1,"ApproverTypeID":1}'

Responses

Status Code	Description
200	The record after the update.

GET /project_manage/approver_master/

Returns the approver types available when building a policy, such as certificate owner, a quorum, or no approval.

Example Request

curl -X GET "https://<your domain>/api/project_manage/approver_master/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/approver_master/

Adds an approver type.

Request Body (application/json)

Field	Type	Required	Description
ApproverType	integer	No	ApproverType
ApproverTypeName	string	Yes	ApproverTypeName
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted

Example Request

curl -X POST "https://<your domain>/api/project_manage/approver_master/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"ApproverTypeName":"string"}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/approver_master/{id}/

Returns one approver type by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this env approval types_ table.

Example Request

curl -X GET "https://<your domain>/api/project_manage/approver_master/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /project_manage/approver_master/{id}/

Replaces an approver type. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this env approval types_ table.

Request Body (application/json)

Field	Type	Required	Description
ApproverType	integer	No	ApproverType
ApproverTypeName	string	Yes	ApproverTypeName
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted

Example Request

curl -X PUT "https://<your domain>/api/project_manage/approver_master/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"ApproverTypeName":"string"}'

Responses

Status Code	Description
200	The record after the update.

PATCH /project_manage/approver_master/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this env approval types_ table.

Request Body (application/json)

Field	Type	Required	Description
ApproverType	integer	No	ApproverType
ApproverTypeName	string	Yes	ApproverTypeName
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted

Example Request

curl -X PATCH "https://<your domain>/api/project_manage/approver_master/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"ApproverTypeName":"string"}'

Responses

Status Code	Description
200	The record after the update.

GET /project_manage/approver_options/

Returns the users who can be named as approvers, for populating a picker.

Example Request

curl -X GET "https://<your domain>/api/project_manage/approver_options/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/approver_options/

Returns the users who can be named as approvers, narrowed by the criteria sent.

Request Body (application/json)

Field	Type	Required	Description
ApproverType	integer	No	ApproverType
ApproverTypeName	string	Yes	ApproverTypeName
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted

Example Request

curl -X POST "https://<your domain>/api/project_manage/approver_options/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"ApproverTypeName":"string"}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/basic/

Returns the applications registered on the appliance.

Request Parameters

Name	Located In	Type	Required	Description
filters	Query	string	No	JSON array of {"field": .., "operator": .., "value": ..} objects, all of which must match. Fields: Application_Name, Application_Description, Created_On, Application_Owner. Text fields take equals, not_equals, contains, not_contains, starts_with or ends_with; date fields take date_is, date_is_not, date_is_before or date_is_after with a YYYY-MM-DD value. Unknown fields and operators are ignored. Application_Owner is matched against the owners' email addresses.
page	Query	integer	No	1-based page number. Defaults to 1.
count	Query	integer	No	Records per page. Defaults to 10.

Example Request

curl -X GET "https://<your domain>/api/project_manage/basic/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/basic/

Registers an application that certificates and environments can be mapped to.

Request Body (application/json)

Field	Type	Required	Description
project_name	string	Yes	Project name
description	string	Yes	Description
business_unit	string	Yes	Business unit
owner	object	Yes	Owner
repository_url	string (uri)	No	Repository url
artifact_type	object	Yes	Artifact type
status	string	No	Status
created_date	string (date-time)	No	Created date
Is_deleted	boolean	No	Is deleted
created_user	integer	No	Created user
modified_by	integer	No	Modified by

Example Request

curl -X POST "https://<your domain>/api/project_manage/basic/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"project_name":"string","description":"string","business_unit":"string","owner":{},"artifact_type":{}}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/basic/{id}/

Returns one application by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Example Request

curl -X GET "https://<your domain>/api/project_manage/basic/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /project_manage/basic/{id}/

Replaces an application. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Request Body (application/json)

Field	Type	Required	Description
project_name	string	Yes	Project name
description	string	Yes	Description
business_unit	string	Yes	Business unit
owner	object	Yes	Owner
repository_url	string (uri)	No	Repository url
artifact_type	object	Yes	Artifact type
status	string	No	Status
created_date	string (date-time)	No	Created date
Is_deleted	boolean	No	Is deleted
created_user	integer	No	Created user
modified_by	integer	No	Modified by

Example Request

curl -X PUT "https://<your domain>/api/project_manage/basic/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"project_name":"string","description":"string","business_unit":"string","owner":{},"artifact_type":{}}'

Responses

Status Code	Description
200	The record after the update.

PATCH /project_manage/basic/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Request Body (application/json)

Field	Type	Required	Description
project_name	string	Yes	Project name
description	string	Yes	Description
business_unit	string	Yes	Business unit
owner	object	Yes	Owner
repository_url	string (uri)	No	Repository url
artifact_type	object	Yes	Artifact type
status	string	No	Status
created_date	string (date-time)	No	Created date
Is_deleted	boolean	No	Is deleted
created_user	integer	No	Created user
modified_by	integer	No	Modified by

Example Request

curl -X PATCH "https://<your domain>/api/project_manage/basic/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"project_name":"string","description":"string","business_unit":"string","owner":{},"artifact_type":{}}'

Responses

Status Code	Description
200	The record after the update.

GET /project_manage/create_certificate/

Returns the certificates available to applications.

Example Request

curl -X GET "https://<your domain>/api/project_manage/create_certificate/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/create_certificate/

Creates a certificate association for an application.

Request Body (application/json)

Field	Type	Required	Description
need_mfa	boolean	No	Need mfa
status	integer	No	Status
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
project_id	integer	Yes	Project id
environment_id	integer	Yes	Environment id
certificate_id	integer	Yes	Certificate id

Example Request

curl -X POST "https://<your domain>/api/project_manage/create_certificate/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"project_id":1,"environment_id":1,"certificate_id":1}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/create_certificate/{project_id}/

Returns the certificates attached to one application.

Request Parameters

Name	Located In	Type	Required	Description
project_id	Path	integer	Yes	Identifier of the application.

Example Request

curl -X GET "https://<your domain>/api/project_manage/create_certificate/<project_id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/create_certificate/{project_id}/

Attaches a certificate to one application.

Request Parameters

Name	Located In	Type	Required	Description
project_id	Path	integer	Yes	Identifier of the application.

Request Body (application/json)

Field	Type	Required	Description
need_mfa	boolean	No	Need mfa
status	integer	No	Status
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
project_id	integer	Yes	Project id
environment_id	integer	Yes	Environment id
certificate_id	integer	Yes	Certificate id

Example Request

curl -X POST "https://<your domain>/api/project_manage/create_certificate/<project_id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"project_id":1,"environment_id":1,"certificate_id":1}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/create_certificates/

Returns the certificates that can be assigned to teams.

Example Request

curl -X GET "https://<your domain>/api/project_manage/create_certificates/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/create_certificates/

Makes a certificate assignable to teams.

Request Body (application/json)

Field	Type	Required	Description
certificate_name	string	Yes	Certificate name

Example Request

curl -X POST "https://<your domain>/api/project_manage/create_certificates/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_name":"string"}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/create_certificates/{id}/

Returns the teams currently holding one certificate.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string (uuid)	Yes	Identifier of the certificate.

Example Request

curl -X GET "https://<your domain>/api/project_manage/create_certificates/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /project_manage/create_certificates/{id}/teams/

Returns the team assignments for one certificate.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string (uuid)	Yes	Identifier of the certificate.

Example Request

curl -X GET "https://<your domain>/api/project_manage/create_certificates/<id>/teams/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/create_environment/

Creates an environment and, optionally, its approval policy in a single call.

Request Body (application/json)

Field	Type	Required	Description
environment	object	Yes	The environment to create.
policy	object	No	Approval policy for the environment. Omit to create it without one.

Example Request

curl -X POST "https://<your domain>/api/project_manage/create_environment/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"environment":{},"policy":{}}'

Responses

Status Code	Description
200	The operation completed.

PUT /project_manage/create_environment/{env_id}/

Updates an environment and its approval policy together.

Request Parameters

Name	Located In	Type	Required	Description
env_id	Path	integer	Yes	Identifier of the environment.

Request Body (application/json)

Field	Type	Required	Description
environment	object	Yes	Environment fields to change. Fields left out keep their value, but the object itself must be present and not empty.
policy	object	Yes	The policy to apply. Send {} to remove the environment's policy.

Example Request

curl -X PUT "https://<your domain>/api/project_manage/create_environment/<env_id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"environment":{},"policy":{}}'

Responses

Status Code	Description
200	The record after the update.

GET /project_manage/environment/

Returns the environments configured on the appliance, such as development, test and production.

Example Request

curl -X GET "https://<your domain>/api/project_manage/environment/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/environment/

Adds an environment that certificates and approval policy can be attached to.

Request Body (application/json)

Field	Type	Required	Description
Enviornment_Name	string	Yes	Enviornment Name
status	string	No	Status
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
Is_deleted	boolean	No	Is deleted
need_mfa	boolean	No	Need mfa

Example Request

curl -X POST "https://<your domain>/api/project_manage/environment/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Enviornment_Name":"string"}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/environment/{id}/

Returns one environment by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this environment_ table.

Example Request

curl -X GET "https://<your domain>/api/project_manage/environment/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /project_manage/environment/{id}/

Replaces an environment. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this environment_ table.

Request Body (application/json)

Field	Type	Required	Description
Enviornment_Name	string	Yes	Enviornment Name
status	string	No	Status
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
Is_deleted	boolean	No	Is deleted
need_mfa	boolean	No	Need mfa

Example Request

curl -X PUT "https://<your domain>/api/project_manage/environment/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Enviornment_Name":"string"}'

Responses

Status Code	Description
200	The record after the update.

PATCH /project_manage/environment/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	integer	Yes	A unique integer value identifying this environment_ table.

Request Body (application/json)

Field	Type	Required	Description
Enviornment_Name	string	Yes	Enviornment Name
status	string	No	Status
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
Is_deleted	boolean	No	Is deleted
need_mfa	boolean	No	Need mfa

Example Request

curl -X PATCH "https://<your domain>/api/project_manage/environment/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Enviornment_Name":"string"}'

Responses

Status Code	Description
200	The record after the update.

GET /project_manage/environment_details/

Returns each environment together with its approval policy and approvers.

Example Request

curl -X GET "https://<your domain>/api/project_manage/environment_details/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /project_manage/environment_details/{env_id}/

Returns one environment together with its approval policy and approvers.

Request Parameters

Name	Located In	Type	Required	Description
env_id	Path	integer	Yes	Identifier of the environment.

Example Request

curl -X GET "https://<your domain>/api/project_manage/environment_details/<env_id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /project_manage/environment_names/

Returns environment names, for populating a picker.

Example Request

curl -X GET "https://<your domain>/api/project_manage/environment_names/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /project_manage/manage_environment/

Returns environments with the certificates and applications attached to each.

Example Request

curl -X GET "https://<your domain>/api/project_manage/manage_environment/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /project_manage/manage_environment/delete/{env_id}/

Returns what is attached to an environment, so the effect of removing it can be reviewed first.

Request Parameters

Name	Located In	Type	Required	Description
env_id	Path	integer	Yes	Identifier of the environment.

Example Request

curl -X GET "https://<your domain>/api/project_manage/manage_environment/delete/<env_id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

GET /project_manage/project_certificate_mapping/

Returns which certificates may be used with which application and environment.

Example Request

curl -X GET "https://<your domain>/api/project_manage/project_certificate_mapping/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/project_certificate_mapping/

Permits a certificate to be used with an application in a given environment.

Request Body (application/json)

Field	Type	Required	Description
project_id	integer	Yes	Application the certificate is mapped to.
environment_id	integer	Yes	Environment the mapping applies to.
certificate_id	integer	Yes	Certificate being mapped.

Example Request

curl -X POST "https://<your domain>/api/project_manage/project_certificate_mapping/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"project_id":1,"environment_id":1,"certificate_id":1}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/project_certificate_mapping/{id}/

Returns one mapping by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Example Request

curl -X GET "https://<your domain>/api/project_manage/project_certificate_mapping/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /project_manage/project_certificate_mapping/{id}/

Replaces a mapping. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Request Body (application/json)

Field	Type	Required	Description
need_mfa	boolean	No	Need mfa
status	integer	No	Status
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
project_id	integer	Yes	Project id
environment_id	integer	Yes	Environment id
certificate_id	integer	Yes	Certificate id

Example Request

curl -X PUT "https://<your domain>/api/project_manage/project_certificate_mapping/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"project_id":1,"environment_id":1,"certificate_id":1}'

Responses

Status Code	Description
200	The record after the update.

PATCH /project_manage/project_certificate_mapping/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string	Yes

Request Body (application/json)

Field	Type	Required	Description
need_mfa	boolean	No	Need mfa
status	integer	No	Status
created_user	integer	No	Created user
created_date	string (date-time)	No	Created date
modified_by	integer	No	Modified by
Is_deleted	boolean	No	Is deleted
project_id	integer	Yes	Project id
environment_id	integer	Yes	Environment id
certificate_id	integer	Yes	Certificate id

Example Request

curl -X PATCH "https://<your domain>/api/project_manage/project_certificate_mapping/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"project_id":1,"environment_id":1,"certificate_id":1}'

Responses

Status Code	Description
200	The record after the update.

GET /project_manage/teams/

Returns the teams defined on the appliance and their members. Team membership is what grants a user access to a certificate.

Example Request

curl -X GET "https://<your domain>/api/project_manage/teams/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

POST /project_manage/teams/

Creates a team and its membership.

Request Body (application/json)

Field	Type	Required	Description
team_name	string	Yes	Team name
member_ids	array of integer	Yes
certificate_ids	array of string	No

Example Request

curl -X POST "https://<your domain>/api/project_manage/teams/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"team_name":"string","member_ids":1,"certificate_ids":[]}'

Responses

Status Code	Description
201	The operation completed.

GET /project_manage/teams/{id}/

Returns one team by identifier.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string (uuid)	Yes	A UUID string identifying this team.

Example Request

curl -X GET "https://<your domain>/api/project_manage/teams/<id>/" \
  -H "Authorization: Bearer <token>"

Responses

Status Code	Description
200	The requested records.

PUT /project_manage/teams/{id}/

Replaces a team. Send the full set of fields.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string (uuid)	Yes	A UUID string identifying this team.

Request Body (application/json)

Field	Type	Required	Description
team_name	string	Yes	Team name
member_ids	array of integer	Yes
certificate_ids	array of string	No

Example Request

curl -X PUT "https://<your domain>/api/project_manage/teams/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"team_name":"string","member_ids":1,"certificate_ids":[]}'

Responses

Status Code	Description
200	The record after the update.

PATCH /project_manage/teams/{id}/

Updates selected fields. Send only the fields to change.

Request Parameters

Name	Located In	Type	Required	Description
id	Path	string (uuid)	Yes	A UUID string identifying this team.

Request Body (application/json)

Field	Type	Required	Description
team_name	string	Yes	Team name
member_ids	array of integer	Yes
certificate_ids	array of string	No

Example Request

curl -X PATCH "https://<your domain>/api/project_manage/teams/<id>/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"team_name":"string","member_ids":1,"certificate_ids":[]}'

Responses

Status Code	Description
200	The record after the update.

POST /project_manage/update_certificate_teams/

Replaces the set of teams permitted to use a certificate.

Request Body (application/json)

Field	Type	Required	Description
certificate_id	string (uuid)	Yes	Certificate to update.
team_list	array of string (uuid)	Yes	Identifiers of every team that should hold the certificate. Teams not listed lose access.

Example Request

curl -X POST "https://<your domain>/api/project_manage/update_certificate_teams/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"certificate_id":"string","team_list":[]}'

Responses

Status Code	Description
200	The operation completed.

Applications and Environments

GET /project_manage/ApprovalDetailsByEnvId/{env_id}/

POST /project_manage/ApprovalDetailsByEnvId/{env_id}/

GET /project_manage/ApprovalDetailsByEnvMappingId/{env_cert_mapping_id}/

POST /project_manage/ApprovalDetailsByEnvMappingId/{env_cert_mapping_id}/

GET /project_manage/approval/

POST /project_manage/approval/

GET /project_manage/approval/{id}/

PUT /project_manage/approval/{id}/

PATCH /project_manage/approval/{id}/

GET /project_manage/approver_master/

POST /project_manage/approver_master/

GET /project_manage/approver_master/{id}/

PUT /project_manage/approver_master/{id}/

PATCH /project_manage/approver_master/{id}/

GET /project_manage/approver_options/

POST /project_manage/approver_options/

GET /project_manage/basic/

POST /project_manage/basic/

GET /project_manage/basic/{id}/

PUT /project_manage/basic/{id}/

PATCH /project_manage/basic/{id}/

GET /project_manage/create_certificate/

POST /project_manage/create_certificate/

GET /project_manage/create_certificate/{project_id}/

POST /project_manage/create_certificate/{project_id}/

GET /project_manage/create_certificates/

POST /project_manage/create_certificates/

GET /project_manage/create_certificates/{id}/

GET /project_manage/create_certificates/{id}/teams/

POST /project_manage/create_environment/

PUT /project_manage/create_environment/{env_id}/

GET /project_manage/environment/

POST /project_manage/environment/

GET /project_manage/environment/{id}/

PUT /project_manage/environment/{id}/

PATCH /project_manage/environment/{id}/

GET /project_manage/environment_details/

GET /project_manage/environment_details/{env_id}/

GET /project_manage/environment_names/

GET /project_manage/manage_environment/

GET /project_manage/manage_environment/delete/{env_id}/

GET /project_manage/project_certificate_mapping/

POST /project_manage/project_certificate_mapping/

GET /project_manage/project_certificate_mapping/{id}/

PUT /project_manage/project_certificate_mapping/{id}/

PATCH /project_manage/project_certificate_mapping/{id}/

GET /project_manage/teams/

POST /project_manage/teams/

GET /project_manage/teams/{id}/

PUT /project_manage/teams/{id}/

PATCH /project_manage/teams/{id}/

POST /project_manage/update_certificate_teams/

On this Page: