API docs by Redocly

ctsubmit API (1.0.2)

Download OpenAPI specification:

Rob Stradling: rob@sectigo.com URL: https://github.com/crtsh/ctsubmit/blob/main/README.md#about-this-project License: GNU General Public License v3.0 or later

CT Submission Proxy

submission

Operations related to submitting certificates and precertificates

Submit a Certificate

Submit a Certificate to a set of Certificate Transparency logs

query Parameters
format
string
Default: "json"
Enum: "html" "json"

The desired response format

Request Body schema: application/json
required

The parameters for the submission request

chain
required
Array of strings

An array of base64-encoded certificates. The first element is the end-entity certificate; the second chains to the first and so on to the last, which is either the root certificate or a certificate that chains to a known root certificate

discoverChain
boolean
Default: false

If true, attempt to discover and append missing intermediate CA certificates to the submitted chain using precomputed optimal parent data derived from CCADB

policyCompliant
boolean
Default: true

If true, ensure the resulting SCT list meets the requirements of the applicable CT policies

mimics
boolean
Default: false

If true, also generate SCTs from the log mimics (see https://googlechrome.github.io/CertificateTransparency/3p_libraries.html)

testLogs
boolean
Default: false

If true, submit to Test CT logs instead of Production CT logs. Also suppresses the ctlint findings that only arise because the SCTs come from test logs absent from ctlint's bundled production log lists

operators
integer
Default: 1

The minimum number of log operators from which to obtain SCTs (overridden if policyCompliant is true and the policies require SCTs from more log operators)

scts
integer
Default: 1

The minimum number of SCTs to obtain from CT logs (overridden if policyCompliant is true and the policies require more SCTs)

requireAtLeastOneRFC6962SCT
boolean
Default: false

If true, require at least one SCT from an RFC6962 log

preferAtLeastOneStaticSCT
boolean
Default: false

If true, prefer at least one SCT from a Static CT API log

verbose
boolean
Default: false

If true, include the submission strategy in the response

Responses

Request samples

Content type
application/json
{
  • "chain": [
    ],
  • "discoverChain": false,
  • "policyCompliant": true,
  • "mimics": false,
  • "testLogs": false,
  • "operators": 1,
  • "scts": 1,
  • "requireAtLeastOneRFC6962SCT": false,
  • "preferAtLeastOneStaticSCT": false,
  • "verbose": false
}

Response samples

Content type
{
  • "logResponse": [
    ],
  • "sctListB64": "string",
  • "finalTBSCertB64": "string",
  • "ctlint": [
    ],
  • "strategy": [
    ]
}

Submit a Precertificate

Submit a Precertificate to a set of Certificate Transparency logs

query Parameters
format
string
Default: "json"
Enum: "html" "json"

The desired response format

Request Body schema: application/json
required

The parameters for the submission request

chain
required
Array of strings

An array of base64-encoded certificates. The first element is the end-entity certificate; the second chains to the first and so on to the last, which is either the root certificate or a certificate that chains to a known root certificate

discoverChain
boolean
Default: false

If true, attempt to discover and append missing intermediate CA certificates to the submitted chain using precomputed optimal parent data derived from CCADB

policyCompliant
boolean
Default: true

If true, ensure the resulting SCT list meets the requirements of the applicable CT policies

mimics
boolean
Default: false

If true, also generate SCTs from the log mimics (see https://googlechrome.github.io/CertificateTransparency/3p_libraries.html)

testLogs
boolean
Default: false

If true, submit to Test CT logs instead of Production CT logs. Also suppresses the ctlint findings that only arise because the SCTs come from test logs absent from ctlint's bundled production log lists

operators
integer
Default: 1

The minimum number of log operators from which to obtain SCTs (overridden if policyCompliant is true and the policies require SCTs from more log operators)

scts
integer
Default: 1

The minimum number of SCTs to obtain from CT logs (overridden if policyCompliant is true and the policies require more SCTs)

requireAtLeastOneRFC6962SCT
boolean
Default: false

If true, require at least one SCT from an RFC6962 log

preferAtLeastOneStaticSCT
boolean
Default: false

If true, prefer at least one SCT from a Static CT API log

verbose
boolean
Default: false

If true, include the submission strategy in the response

Responses

Request samples

Content type
application/json
{
  • "chain": [
    ],
  • "discoverChain": false,
  • "policyCompliant": true,
  • "mimics": false,
  • "testLogs": false,
  • "operators": 1,
  • "scts": 1,
  • "requireAtLeastOneRFC6962SCT": false,
  • "preferAtLeastOneStaticSCT": false,
  • "verbose": false
}

Response samples

Content type
{
  • "logResponse": [
    ],
  • "sctListB64": "string",
  • "finalTBSCertB64": "string",
  • "ctlint": [
    ],
  • "strategy": [
    ]
}

log-lists

Operations related to retrieving CT log lists

Usable TLS Logs

Return the list of Usable TLS CT logs

Responses

Response samples

Content type
application/json
{ }

Active TLS Logs

Return the list of Active TLS CT logs

Responses

Response samples

Content type
application/json
{ }

Test TLS Logs

Return the list of Test TLS CT logs

Responses

Response samples

Content type
application/json
{ }

Usable BIMI Logs

Return the list of Usable BIMI CT logs

Responses

Response samples

Content type
application/json
{ }

monitoring

Operations related to monitoring the submission operations

Submission dashboard

Show a dashboard of CT log submission activity

query Parameters
loglist
string
Default: "usabletls"
Enum: "usabletls" "activetls" "testtls" "usablebimi"

Which log list to display in the dashboard

Responses

webpages

Static webpages and assets

Front page

Show the front page with links to API documentation, submission webpages, log lists, and dashboards

Responses

Certificate submission webpage

Show a webpage for interactively submitting a Certificate

Responses

Precertificate submission webpage

Show a webpage for interactively submitting a Precertificate

Responses