Skip to main content
New to Corsair? See API access, authentication, and error handling.

Artifact Configurations

activate

artifactConfigurations.activate Activate an artifact configuration; safe to repeat Risk: write
Input Output

deactivate

artifactConfigurations.deactivate Deactivate an artifact configuration; safe to repeat Risk: write
Input Output

getXml

artifactConfigurations.getXml Read an artifact configuration as XML, which is how SignPath stores and version-controls it Risk: read
Input Output

updateXml

artifactConfigurations.updateXml Replace an artifact configuration’s XML; SignPath does not merge it, and existing signing requests keep the version they captured Risk: write
Input The whole document is replaced. Existing signing requests keep the configuration they captured when they were submitted. Output

Audit Log

listEvents

auditLog.listEvents Read organization audit log events from a cursor or a start time; this route is under the v1-pre preview path Risk: read
Input Output

listSigningRequestEvents

auditLog.listSigningRequestEvents Read only the signing request audit log events from a cursor or a start time; this route is under the v1-pre preview path Risk: read
Input Output

Certificates

get

certificates.get Read one certificate: its status, key algorithm, subject and X509 validity or GPG fingerprint Risk: read
Input Output

list

certificates.list List the organization’s X509 and GPG certificates with status, algorithm and validity; this route does not page Risk: read
Input: empty object Output

Organization

get

organization.get Read the organization name, subscription type and quota usage: active users, active projects, certificates, yearly signatures and artifact bytes Risk: read
Input: empty object Output

Projects

activate

projects.activate Activate a project so it accepts signing requests; safe to repeat Risk: write
Input Output

create

projects.create Create a project with an artifact configuration; the project starts inactive, so activate it before submitting signing requests Risk: write
Input artifactConfigurationXml is required. SignPath rejects a project without one, so send the configuration you want on day one. Output

deactivate

projects.deactivate Deactivate a project, which blocks new signing requests until it is activated again; safe to repeat Risk: write
Input Output

get

projects.get Read one project with its artifact configurations, signing policies, trusted build system links, readers and configurators Risk: read
Input Output

list

projects.list List every project in the organization with its status and signing policies; this route does not page Risk: read
Input: empty object Output

setDefaultArtifactConfiguration

projects.setDefaultArtifactConfiguration Choose which artifact configuration a signing request uses when it names none Risk: write
Input Output

update

projects.update Change a project name, description, repository URLs, readers or configurators; the body requires the slug, so pass the project’s own slug to keep it Risk: write
Input The body requires both name and slug. Pass the project’s own slug to leave the URL unchanged. Output

Signing Policies

activate

signingPolicies.activate Activate a signing policy so it accepts submissions; safe to repeat Risk: write
Input Output

create

signingPolicies.create Add a signing policy to a project; it is created inactive, so activate it before it accepts submissions Risk: write
Input The policy is created inactive. Call signingPolicies.activate before it accepts submissions.
Output

deactivate

signingPolicies.deactivate Deactivate a signing policy, which blocks new submissions under it; safe to repeat Risk: write
Input Output

get

signingPolicies.get Read one signing policy: its certificate, submitters, approvers, required approval count and build system verification Risk: read
Input Output

update

signingPolicies.update Replace a signing policy’s certificate, submitters, approvals and verification settings; the body requires the slug, so pass the policy’s own slug to keep it Risk: write
Input The body requires the full policy, not just the fields you are changing. Read it first with signingPolicies.get.
Output

Signing Requests

approve

signingRequests.approve Approve a signing request waiting for approval; SignPath accepts it once the policy’s required approval count is reached Risk: destructive
Input Output

cancel

signingRequests.cancel Cancel a signing request that has not finished; a cancelled request cannot be resumed, so a new one has to be submitted Risk: destructive · Irreversible
Input Output

deny

signingRequests.deny Deny a signing request, which immediately marks it rejected; a denied request cannot be approved afterwards Risk: destructive · Irreversible
Input Deny is permanent. A denied request cannot be approved later; submit a new one instead. Output

get

signingRequests.get Read one signing request with its status, workflow status, artifact links and verified origin when the build system provided one Risk: read
Input Output

getStatus

signingRequests.getStatus Read only a signing request’s status and workflow status, which is the cheap poll while it waits for approval or processing Risk: read
Input Output

list

signingRequests.list List signing requests with filters for project, policy, configuration, certificate, status and submission time; follow pagination.nextLink for the next page Risk: read
Input nextLink replaces your filters rather than adding to them, because SignPath already encoded them into the URL. Output

resubmit

signingRequests.resubmit Resubmit a completed signing request under another policy, which is how a test-signed artifact is promoted to release signing; returns the new request id from the Location header Risk: destructive
Input Output

signHash

signingRequests.signHash Sign a hash with the policy’s key and return the signature in the response, without an artifact or a waiting period Risk: destructive · Irreversible
Input rsaOptions, ecdsaOptions and mldsaOptions are required to match signatureAlgorithm. The schema rejects a call that omits the one it needs.
Output

signMessage

signingRequests.signMessage Sign a message with ML-DSA and return the signature in the response; PureMldsa is the only algorithm SignPath offers here Risk: destructive · Irreversible
Input
Output

submitWithArtifact

signingRequests.submitWithArtifact Submit an artifact for signing, uploading the bytes in the same call; the request then waits for approval and processing Risk: destructive
Input artifactBase64 is decoded before the request, so a 10 MB artifact is about 13.3 MB of input. Use submitWithArtifactRetrievalLink for anything large. Output

signingRequests.submitWithArtifactRetrievalLink Submit a signing request that points at an artifact SignPath downloads itself, which is the route for artifacts too large to upload Risk: destructive
Input Output

submitWithoutArtifact

signingRequests.submitWithoutArtifact Submit a signing request before the artifact exists, returning the upload link the artifact must be delivered to Risk: destructive
Input Output

Users

me

users.me Read the authenticated user: their id, role, status and whether they are a CI user or an interactive user Risk: read
Input: empty object Output