Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Server

Bitbucket Data Center / / Modules

Signing

Operations

GET/api/latest/signing/x509-certificates POST/api/latest/signing/x509-certificates PUT/api/latest/signing/x509-certificates/crl/{id}DEL/api/latest/signing/x509-certificates/{id}

GET

Get all X.509 certificates

Get all X.509 certificates that have been added to the system.

The authenticated user must have the ADMIN permission to call this resource.

Request

This request has no parameters.

Responses

A page of X.509 certificates

application/json

RestX509Certificate

GET/api/latest/signing/x509-certificates

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/signing/x509-certificates' \
  --header 'Accept: application/json'

200Response

{
  "fingerprint": "e5e8d632c0b86f5bd5ef9a0d55c58ba1fd7776f6bb7c35ca23d85d23281ce58f",
  "id": 7
}

POST

Create an X.509 certificate

Create an X.509 certificate. This will add the given X.509 certificate to the system. Existing entries will not be overridden if an X.509 certificate already exists. Once added, an X.509 certificate cannot be updated.

The authenticated user must have the ADMIN permission to call this resource.

Request

Request bodymultipart/form-data

The multipart form data containing the certificate in a form-field named 'certificate'

certificate

string

Responses

The newly created X.509 certificate

application/json

RestX509Certificate

POST/api/latest/signing/x509-certificates

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/latest/signing/x509-certificates' \
  --header 'Accept: application/json'

201Response

{
  "fingerprint": "e5e8d632c0b86f5bd5ef9a0d55c58ba1fd7776f6bb7c35ca23d85d23281ce58f",
  "id": 7
}

PUT

Update X.509 CRL entries

Update the certificate revocation list (CRL) entries for an issuer X.509 certificate in the system, identified by id. This will add any new revoked X.509 certificates that were issued by the given issuer X.509 certificate.

This endpoint will schedule a request to asynchronously perform the task. Please allow time for the task to complete as it will vary depending on how many CRLs there are to retrieve and process.

Note: CRL updates are scheduled to run every 24 hours. You may wish to trigger a refresh manually using this endpoint, otherwise, entries will be updated daily.

The authenticated user must have the ADMIN permission to call this resource.

Request

Path parameters

string

Required

Responses

Successfully started processing CRLs.

application/json

any

PUT/api/latest/signing/x509-certificates/crl/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'http://{baseurl}/rest/api/latest/signing/x509-certificates/crl/{id}' \
  --header 'Accept: application/json'

DEL

Delete an X.509 certificate

Delete an X.509 certificate specified by the given ID.

The authenticated user must have the ADMIN permission to call this resource.

Request

Path parameters

string

Required

Responses

An empty response if the X.509 certificate was successfully deleted

application/json

RestX509Certificate

DEL/api/latest/signing/x509-certificates/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/latest/signing/x509-certificates/{id}' \
  --header 'Accept: application/json'

204Response

{
  "fingerprint": "e5e8d632c0b86f5bd5ef9a0d55c58ba1fd7776f6bb7c35ca23d85d23281ce58f",
  "id": 7
}