CZERTAINLY ACME API (2.13.1)

Download OpenAPI specification:Download

CZERTAINLY: info@czertainly.com URL: https://www.czertainly.com License: MIT License

REST API for managing ACME Profiles and ACME Accounts in the platform

CZERTAINLY Documentation

ACME Account Management

ACME Account Management API

Revoke multiple ACME Accounts

Request Body schema: application/json
required

ACME Account UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Details of ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"accountId": "TtrgfYTR6F",
"uuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"enabled": false,
"totalOrders": 23,
"successfulOrders": 2,
"failedOrders": 239,
"pendingOrders": 24,
"validOrders": 23,
"processingOrders": 27,
"status": "VALID",
"contact": "mailto: someadmin@domain.com",
"termsOfServiceAgreed": true,
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"acmeProfileName": "ACME Profile 1",
"acmeProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002"
}

Revoke ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple ACME Accounts

Request Body schema: application/json
required

ACME Account UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable multiple ACME Accounts

Request Body schema: application/json
required

ACME Account UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List ACME Accounts

Responses

Response samples

200
400
403
404

Content type

application/json

[{"accountId": "HJAT6gc7i6",
"uuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"enabled": false,
"totalOrders": 4,
"status": "VALID",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"acmeProfileName": "ACMEProfile1",
"acmeProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002"
}
]

ACME Profile Management

ACME Profile Management API

Get details of ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-company.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"retryInterval": 30,
"termsOfServiceChangeDisable": false,
"validity": 36000,
"directoryUrl": "https://some-server.com/api/v1/protocols/acme/profile1/directory",
"termsOfServiceChangeUrl": "https://some-company.com/termsOfService/change",
"requireContact": true,
"requireTermsOfService": true,
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Edit ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Request Body schema: application/json
required

description	string Description of the ACME Profile
termsOfServiceUrl	string Terms of Service URL
websiteUrl	string Website URL
dnsResolverIp	string Default: "System Default" DNS Resolver IP address
dnsResolverPort	string Default: "53" DNS Resolver port number
raProfileUuid	string RA Profile UUID
retryInterval	integer <int32> Default: 30 Retry interval for the Orders
termsOfServiceChangeDisable	boolean Default: false Disable new Orders due to change in Terms of Service
termsOfServiceChangeUrl	string Changes of Terms of Service URL
validity	integer <int32> Default: 36000 Order Validity
required	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate
required	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate
requireContact	boolean Default: false Require contact information for new Account
requireTermsOfService	boolean Default: false Require new Account to agree on Terms of Service
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-url.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"retryInterval": 60,
"termsOfServiceChangeDisable": false,
"termsOfServiceChangeUrl": "https://sample-url.com/termsOfService/change",
"validity": 3000,
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"requireContact": true,
"requireTermsOfService": false,
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-company.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"retryInterval": 30,
"termsOfServiceChangeDisable": false,
"validity": 36000,
"directoryUrl": "https://some-server.com/api/v1/protocols/acme/profile1/directory",
"termsOfServiceChangeUrl": "https://some-company.com/termsOfService/change",
"requireContact": true,
"requireTermsOfService": true,
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of ACME Profiles

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": false,
"description": "Some description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"directoryUrl": "https://some-server.com/api/v1/protocols/acme/profile1/directory"
}
]

Create ACME Profile

Request Body schema: application/json
required

name required	string Name of the ACME Profile
description	string Description of the ACME Profile
termsOfServiceUrl	string Terms of Service URL
websiteUrl	string Website URL
dnsResolverIp	string Default: "System Default" DNS Resolver IP address
dnsResolverPort	string Default: "53" DNS Resolver port number
raProfileUuid	string RA Profile UUID
retryInterval	integer <int32> Default: 30 Retry interval for the Orders
validity	integer <int32> Default: 36000 Order Validity
required	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate
required	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate
requireContact	boolean Default: false Require contact information for new Account
requireTermsOfService	boolean Default: false Require new Account to agree on Terms of Service
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Profile Name 1",
"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-url.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"retryInterval": 60,
"validity": 3000,
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"requireContact": true,
"requireTermsOfService": false,
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Update RA Profile for ACME Profile

path Parameters

uuid required	string ACME Profile UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple ACME Profiles

Request Body schema: application/json
required

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable multiple ACME Profile

Request Body schema: application/json
required

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Delete multiple ACME Profiles

Request Body schema: application/json
required

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Force delete multiple ACME Profiles

Request Body schema: application/json
required

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404
422

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

CZERTAINLY ACME API (2.13.1)

ACME Account Management

Revoke multiple ACME Accounts

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Details of ACME Account

path Parameters

Responses

Response samples

Revoke ACME Account

path Parameters

Responses

Response samples

Enable ACME Account

path Parameters

Responses

Response samples

Disable ACME Account

path Parameters

Responses

Response samples

Enable multiple ACME Accounts

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Disable multiple ACME Accounts

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List ACME Accounts

Responses

Response samples

ACME Profile Management

Get details of ACME Profile

path Parameters

Responses

Response samples

Edit ACME Profile

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete ACME Profile

path Parameters

Responses

Response samples

Get list of ACME Profiles

Responses

Response samples

Create ACME Profile

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update RA Profile for ACME Profile

path Parameters

Responses

Response samples

Enable ACME Profile

path Parameters

Responses

Response samples

Disable ACME Profile

path Parameters

Responses

Response samples

Enable multiple ACME Profiles

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Disable multiple ACME Profile

Request Body schema: application/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required