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

Server

Bitbucket Data Center / Reference / REST API

Security

Operations

GET

Retrieve inactive AES key(s)

Retrieves a list of inactive AES encryption key(s). An AES key becomes inactive after it has been rotated.

Request

This request has no parameters.

Responses

Returned if the keys were retrieved successfully

GET/secrets/1.0/keys/inactive

curl

Node.js

Java

Python

PHP

1
2

curl --request GET \
  --url 'http://{baseurl}/rest/secrets/1.0/keys/inactive'

DEL

Delete inactive AES key(s)

Delete the inactive AES encryption key(s). Post rotation, inactive AES key(s) can be cleaned up.

Request

This request has no parameters.

Responses

Returned if the keys were deleted successfully

DEL/secrets/1.0/keys/inactive

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/secrets/1.0/keys/inactive'

POST

Rotate the current AES key

Rotate the current AES encryption key. Existing secrets will be re-encrypted with the new key.

Request

This request has no parameters.

Responses

Returned if the key was rotated successfully

POST/secrets/1.0/keys/rotate

curl

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'http://{baseurl}/rest/secrets/1.0/keys/rotate'

GET

Get all GPG keys

Find all the keys for the currently authenticated user. Optionally, users with ADMIN and higher permissions may choose to specify the user parameter to retrieve GPG keys for another user.

Only authenticated users may call this endpoint.

Request

Query parameters

user

string

start

number

limit

number

Responses

Returns a paged response of of keys for the user.

application/json

object

GET/gpg/latest/keys

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/gpg/latest/keys' \
  --header 'Accept: application/json'

200Response

{
  "isLastPage": true,
  "limit": 25,
  "nextPageStart": 2154,
  "size": 1,
  "start": 2154,
  "values": [
    {
      "emailAddress": "bitbucket@example.com",
      "expiryDate": 61550496000000,
      "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8",
      "id": "00000000000004d2",
      "subKeys": []
    }
  ]
}

POST

Create a GPG key

Add a GPG key to the authenticated user's account. Optionally, users with ADMIN and higher permissions may choose to specify the user parameter to add a GPG key for another user.

Only authenticated users may call this endpoint.

Request

Query parameters

user

string

Request bodyapplication/json

The request body.

text

string

Responses

Response contains the GPG key that was just created.

application/json

RestGpgKey

POST/gpg/latest/keys

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/gpg/latest/keys' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "-----BEGIN PGP SIGNATURE-----\n\niQEzBAABCAAdFiEEM8MrWnoxlp3K1lFY5BMGiWNefn4FAlkqKE4ACgkQ5BMGiWNe\nfn6/kggAyzKhDDqdVb3Rq02hiSqeqKa1JuKRqDmzIpa6Pxa+1CpCnxwaIVrGgIii\nvj0ZNJzL1Bm2xm0JasotJDiZq5pFKi0FfQ0WmskuhsW1VY/f08TltHpHvK2kHVRr\nGEMVDUb0nj0I7Duc8XTipiYoDGS1GvydNR/bu3SsFTcZyapXirQcTCRT6/Sn0/IP\npUeIwQo1qK4e8gTOhWhfWEiVig39lQhiZFtm5S/vfAY72/Rgp68zMYmwasMSnBgF\n/LLFW6lXAqZIoAP8AnmsMRjCH6mS98+/lxKq2+K71+2YUUIAnNEeO09Lufo3B3Da\nPbs7BpD28w4lKlzb2EQ0n0C9rrxdPA==\n=VZpm\n-----END PGP SIGNATURE-----\n"
}'

200Response

{
  "emailAddress": "bitbucket@example.com",
  "expiryDate": 61550496000000,
  "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8",
  "id": "00000000000004d2",
  "subKeys": []
}

DEL

Delete all GPG keys for user

Delete all GPG keys for a supplied user.

Request

Query parameters

user

string

Responses

The GPG keys matching the supplied user were deleted.

DEL/gpg/latest/keys

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/gpg/latest/keys'

DEL

Delete a GPG key

Delete the GPG key with the specified ID or Key Fingerprint.

Request

Path parameters

fingerprintOrId

string

Required

Responses

The key has been deleted successfully.

DEL/gpg/latest/keys/{fingerprintOrId}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/gpg/latest/keys/{fingerprintOrId}'

GET

Find repository secret scanning allowlist rules

Find repository secret scanning allowlist rules by filtering.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

repositorySlug

string

Required

Query parameters

filter

string

order

string

start

number

limit

number

Responses

Page of allowlist rules

application/json;charset=UTF-8

object

GET/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist' \
  --header 'Accept: application/json;charset=UTF-8'

POST

Create repository secret scanning allowlist rule

Create a new repository secret scanning allowlist rule. Repository allowlist rules are used when scanning the given repository.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

repositorySlug

string

Required

Request body/

Allowlist rule to create, either the line regular expression or the path regular expression must be present

lineRegex

string

name

string

pathRegex

string

Responses

The created rule

application/json;charset=UTF-8

RestSecretScanningAllowlistRule

POST/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist' \
  --header 'Accept: application/json;charset=UTF-8'

GET

Get a repository secret scanning allowlist rule

Get a repository secret scanning allowlist rule by ID.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

repositorySlug

string

Required

Responses

The requested allowlist rule

application/json;charset=UTF-8

RestSecretScanningAllowlistRule

GET/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

PUT

Edit an existing repository secret scanning allowlist rule

Edit a repository secret scanning allowlist rule.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

repositorySlug

string

Required

Request body/

lineRegex

string

name

string

pathRegex

string

Responses

The updated allowlist rule

application/json;charset=UTF-8

RestSecretScanningAllowlistRule

PUT/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

DEL

Delete a repository secret scanning allowlist rule

Delete a repository secret scanning allowlist rule with the provided ID.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

repositorySlug

string

Required

Responses

Empty response indicating that the allowlist rule was deleted

DEL/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/allowlist/{id}'

GET

Get whether a repository is exempt

Check whether a repository is exempt from secret scanning

Request

This request has no parameters.

Responses

True if the repository is exempt from secret scanning, false otherwise

application/json;charset=UTF-8

any

GET/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt' \
  --header 'Accept: application/json;charset=UTF-8'

PUT

Exempt a repo from secret scanningDeprecated

Exempt a repository from being scanned for secrets

Deprecated since 8.6. Exemptions are now managed by scope. Use POST /rest/api/1.0/secret-scanning/exempt for global scope Use POST /rest/api/1.0/projects/{projectKey}/secret-scanning/exempt for the project scope

Request

This request has no parameters.

Responses

An exempt repo was added

PUT/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt

curl

Node.js

Java

Python

PHP

1
2

curl --request PUT \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt'

DEL

Delete an exempt repository

Remove a repository from being exempt from secret scanning

Request

This request has no parameters.

Responses

Empty response indicating that the exempt repository was deleted

DEL/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/exempt'

GET

Find repository secret scanning rules

Find repository secret scanning rules by filtering.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

repositorySlug

string

Required

Query parameters

filter

string

order

string

start

number

limit

number

Responses

Page of rules

application/json;charset=UTF-8

object

GET/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules' \
  --header 'Accept: application/json;charset=UTF-8'

POST

Create repository secret scanning rule

Create a new repository secret scanning rule. Repository rules are used when scanning the given repository.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

repositorySlug

string

Required

Request body/

Rule to create, either the line regular expression or the path regular expression must be present

lineRegex

string

name

string

pathRegex

string

Responses

The created rule

application/json;charset=UTF-8

RestSecretScanningRule

POST/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules' \
  --header 'Accept: application/json;charset=UTF-8'

GET

Get a repository secret scanning rule

Get a repository secret scanning rule by ID.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

repositorySlug

string

Required

Responses

The requested rule

application/json;charset=UTF-8

RestSecretScanningRule

GET/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

PUT

Edit an existing repository secret scanning rule

Edit a repository secret scanning rule.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

repositorySlug

string

Required

Request body/

lineRegex

string

name

string

pathRegex

string

Responses

The updated rule

application/json;charset=UTF-8

RestSecretScanningRule

PUT/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

DEL

Delete a repository secret scanning rule

Delete a repository secret scanning rule with the provided ID.

Repository Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

repositorySlug

string

Required

Responses

Empty response indicating that the rule was deleted

DEL/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/secret-scanning/rules/{id}'

GET

Find project secret scanning allowlist rules

Find project secret scanning allowlist rules by filtering.

Project Admin is required

Request

Path parameters

projectKey

string

Required

Query parameters

filter

string

order

string

start

number

limit

number

Responses

Page of allowlist rules

application/json;charset=UTF-8

object

GET/api/latest/projects/{projectKey}/secret-scanning/allowlist

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/allowlist' \
  --header 'Accept: application/json;charset=UTF-8'

POST

Create project secret scanning allowlist rule

Create a new project level secret scanning allowlist rule. Project allowlist rules are used when scanning all non exempt repositories in the provided project.

Project Admin is required

Request

Path parameters

projectKey

string

Required

Request body/

Allowlist rule to create, either the line regular expression or the path regular expression must be present

lineRegex

string

name

string

pathRegex

string

Responses

The created allowlist rule

application/json;charset=UTF-8

RestSecretScanningAllowlistRule

POST/api/latest/projects/{projectKey}/secret-scanning/allowlist

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/allowlist' \
  --header 'Accept: application/json;charset=UTF-8'

GET

Get a project secret scanning allowlist rule

Get a project secret scanning allowlist rule by ID.

Project Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

Responses

The requested allowlist rule

application/json;charset=UTF-8

RestSecretScanningAllowlistRule

GET/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

PUT

Edit an existing project secret scanning allowlist rule

Edit a project secret scanning allowlist rule.

Project Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

Request body/

lineRegex

string

name

string

pathRegex

string

Responses

The updated allowlist rule

application/json;charset=UTF-8

RestSecretScanningAllowlistRule

PUT/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

DEL

Delete a project secret scanning allowlist rule

Delete a project secret scanning allowlist rule with the provided ID.

Project Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

Responses

Empty response indicating that the rule was deleted, or not found at this location

DEL/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/allowlist/{id}'

GET

Find repos exempt from secret scanning for a project

Find repositories exempt from secret scanning in a project

Request

Query parameters

order

string

start

number

limit

number

Responses

Page of repositories

application/json;charset=UTF-8

object

GET/api/latest/projects/{projectKey}/secret-scanning/exempt

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/exempt' \
  --header 'Accept: application/json;charset=UTF-8'

POST

Bulk exempt repos from secret scanning

Bulk exempt a list of repositories from being scanned for secrets. User must be have PROJECT ADMIN permissions.

Request

Request body/

array<RestRepositorySelector>

Unique items: true

projectKey

string

slug

string

Responses

All requested repositories were made exempt

POST/api/latest/projects/{projectKey}/secret-scanning/exempt

curl

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/exempt'

GET

Find project secret scanning rules

Find project secret scanning rules by filtering.

Project Admin is required

Request

Path parameters

projectKey

string

Required

Query parameters

filter

string

order

string

start

number

limit

number

Responses

Page of rules

application/json;charset=UTF-8

object

GET/api/latest/projects/{projectKey}/secret-scanning/rules

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/rules' \
  --header 'Accept: application/json;charset=UTF-8'

POST

Create project secret scanning rule

Create a new project level secret scanning rule. Project rules are used when scanning all non exempt repositories in the provided project.

Project Admin is required

Request

Path parameters

projectKey

string

Required

Request body/

Rule to create, either the line regular expression or the path regular expression must be present

lineRegex

string

name

string

pathRegex

string

Responses

The created rule

application/json;charset=UTF-8

RestSecretScanningRule

POST/api/latest/projects/{projectKey}/secret-scanning/rules

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/rules' \
  --header 'Accept: application/json;charset=UTF-8'

GET

Get a project secret scanning rule

Get a project secret scanning rule by ID.

Project Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

Responses

The requested rule

application/json;charset=UTF-8

RestSecretScanningRule

GET/api/latest/projects/{projectKey}/secret-scanning/rules/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/rules/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

PUT

Edit an existing project secret scanning rule

Edit a project secret scanning rule.

Project Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

Request body/

lineRegex

string

name

string

pathRegex

string

Responses

The updated rule

application/json;charset=UTF-8

RestSecretScanningRule

PUT/api/latest/projects/{projectKey}/secret-scanning/rules/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/rules/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

DEL

Delete a project secret scanning rule

Delete a project secret scanning rule with the provided ID.

Project Admin is required

Request

Path parameters

projectKey

string

Required

string

Required

Responses

Empty response indicating that the rule was deleted, or not found at this location

DEL/api/latest/projects/{projectKey}/secret-scanning/rules/{id}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/secret-scanning/rules/{id}'

GET

Find all repos exempt from secret scan

Find all repositories exempt from secret scanning

Request

Query parameters

order

string

start

number

limit

number

Responses

Page of repositories

application/json;charset=UTF-8

object

GET/api/latest/secret-scanning/exempt

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/secret-scanning/exempt' \
  --header 'Accept: application/json;charset=UTF-8'

POST

Bulk exempt repos from secret scanning

Bulk exempt a list of repositories from being scanned for secrets. User must be have global ADMIN permissions.

Request

Request body/

array<RestRepositorySelector>

Unique items: true

projectKey

string

slug

string

Responses

All requested repositories were made exempt

POST/api/latest/secret-scanning/exempt

curl

Node.js

Java

Python

PHP

1
2

curl --request POST \
  --url 'http://{baseurl}/rest/api/latest/secret-scanning/exempt'

GET

Find global secret scanning rules

Find global secret scanning rules by filtering.

Request

Query parameters

filter

string

order

string

start

number

limit

number

Responses

Page of rules

application/json;charset=UTF-8

object

GET/api/latest/secret-scanning/rules

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/secret-scanning/rules' \
  --header 'Accept: application/json;charset=UTF-8'

POST

Create global secret scanning rule

Create a new global secret scanning rule. Global rules are used when scanning all non exempt repositories.

Request

Request body/

Rule to create, either the line regular expression or the path regular expression must be present

lineRegex

string

name

string

pathRegex

string

Responses

The created rule

application/json;charset=UTF-8

RestSecretScanningRule

POST/api/latest/secret-scanning/rules

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/latest/secret-scanning/rules' \
  --header 'Accept: application/json;charset=UTF-8'

GET

Get a global secret scanning rule

Get a global secret scanning rule by ID.

Request

Path parameters

string

Required

Responses

The requested rule

application/json;charset=UTF-8

RestSecretScanningRule

GET/api/latest/secret-scanning/rules/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/secret-scanning/rules/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

PUT

Edit a global secret scanning rule.

Edit an existing global secret scanning rule

Request

Path parameters

string

Required

Request body/

lineRegex

string

name

string

pathRegex

string

Responses

The updated rule

application/json;charset=UTF-8

RestSecretScanningRule

PUT/api/latest/secret-scanning/rules/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'http://{baseurl}/rest/api/latest/secret-scanning/rules/{id}' \
  --header 'Accept: application/json;charset=UTF-8'

DEL

Delete a global secret scanning rule

Delete a global secret scanning rule with the provided ID

Request

Path parameters

string

Required

Responses

Empty response indicating that the rule was deleted

DEL/api/latest/secret-scanning/rules/{id}

curl

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/latest/secret-scanning/rules/{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;charset=UTF-8

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;charset=UTF-8'

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;charset=UTF-8

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;charset=UTF-8'

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;charset=UTF-8

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;charset=UTF-8'

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;charset=UTF-8

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;charset=UTF-8'

GET

Get system signing configuration

Gets the configuration details for system signing Git objects.

Request

This request has no parameters.

Responses

The configuration details for system signing Git objects

application/json;charset=UTF-8

RestSystemSigningConfiguration

GET/api/latest/system-signing/configuration

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/api/latest/system-signing/configuration' \
  --header 'Accept: application/json;charset=UTF-8'

POST

Update system signing configuration

Updates the configuration for system signing Git objects.

Request

Request bodyapplication/json

enabled

boolean

Responses

The updated configuration details for system signing Git objects

application/json;charset=UTF-8

RestSystemSigningConfiguration

POST/api/latest/system-signing/configuration

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/api/latest/system-signing/configuration' \
  --header 'Accept: application/json;charset=UTF-8' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": false
}'

Security

Retrieve inactive AES key(s)

Request

Responses

Delete inactive AES key(s)

Request

Responses

Rotate the current AES key

Request

Responses

Get all GPG keys

Request

Query parameters

Responses

application/json

Create a GPG key

Request

Query parameters

Request bodyapplication/json

Responses

application/json

Delete all GPG keys for user

Request

Query parameters

Responses

Delete a GPG key

Request

Path parameters

Responses

Find repository secret scanning allowlist rules

Request

Path parameters

Query parameters

Responses

application/json;charset=UTF-8

Create repository secret scanning allowlist rule

Request

Path parameters

Request body*/*

Responses

application/json;charset=UTF-8

Get a repository secret scanning allowlist rule

Request

Path parameters

Responses

application/json;charset=UTF-8

Edit an existing repository secret scanning allowlist rule

Request

Path parameters

Request body*/*

Responses

application/json;charset=UTF-8

Delete a repository secret scanning allowlist rule

Request

Path parameters

Responses

Get whether a repository is exempt

Request

Responses

application/json;charset=UTF-8

Exempt a repo from secret scanningDeprecated

Request

Responses

Delete an exempt repository

Request

Responses

Find repository secret scanning rules

Request

Path parameters

Query parameters

Responses

application/json;charset=UTF-8

Create repository secret scanning rule

Request

Path parameters

Request body*/*

Responses

application/json;charset=UTF-8

Get a repository secret scanning rule

Request

Request body/

Request body/

Request body/

Request body/

Request body/

Request body/

Request body/

Request body/

Request body/