Artifact Configurations
activate
artifactConfigurations.activate
Activate an artifact configuration; safe to repeat
Risk: write
deactivate
artifactConfigurations.deactivate
Deactivate an artifact configuration; safe to repeat
Risk: write
getXml
artifactConfigurations.getXml
Read an artifact configuration as XML, which is how SignPath stores and version-controls it
Risk: read
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
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
auditLogEvents full type
auditLogEvents full type
pagination full type
pagination full type
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
auditLogEvents full type
auditLogEvents full type
pagination full type
pagination full type
Certificates
get
certificates.get
Read one certificate: its status, key algorithm, subject and X509 validity or GPG fingerprint
Risk: read
x509CertificateData full type
x509CertificateData full type
gpgKeyData full type
gpgKeyData full type
list
certificates.list
List the organization’s X509 and GPG certificates with status, algorithm and validity; this route does not page
Risk: read
certificates full type
certificates full type
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
quotas full type
quotas full type
Projects
activate
projects.activate
Activate a project so it accepts signing requests; safe to repeat
Risk: write
create
projects.create
Create a project with an artifact configuration; the project starts inactive, so activate it before submitting signing requests
Risk: write
deactivate
projects.deactivate
Deactivate a project, which blocks new signing requests until it is activated again; safe to repeat
Risk: write
get
projects.get
Read one project with its artifact configurations, signing policies, trusted build system links, readers and configurators
Risk: read
artifactConfigurations full type
artifactConfigurations full type
signingPolicies full type
signingPolicies full type
trustedBuildSystemLinks full type
trustedBuildSystemLinks full type
readers full type
readers full type
configurators full type
configurators full type
list
projects.list
List every project in the organization with its status and signing policies; this route does not page
Risk: read
projects full type
projects full type
setDefaultArtifactConfiguration
projects.setDefaultArtifactConfiguration
Choose which artifact configuration a signing request uses when it names none
Risk: write
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
Signing Policies
activate
signingPolicies.activate
Activate a signing policy so it accepts submissions; safe to repeat
Risk: write
create
signingPolicies.create
Add a signing policy to a project; it is created inactive, so activate it before it accepts submissions
Risk: write
approval full type
approval full type
trustedBuildSystemVerification full type
trustedBuildSystemVerification full type
deactivate
signingPolicies.deactivate
Deactivate a signing policy, which blocks new submissions under it; safe to repeat
Risk: write
get
signingPolicies.get
Read one signing policy: its certificate, submitters, approvers, required approval count and build system verification
Risk: read
submitters full type
submitters full type
approvers full type
approvers full type
trustedBuildSystemVerification full type
trustedBuildSystemVerification full type
pipelinePolicies full type
pipelinePolicies full type
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
approval full type
approval full type
trustedBuildSystemVerification full type
trustedBuildSystemVerification full type
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
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
deny
signingRequests.deny
Deny a signing request, which immediately marks it rejected; a denied request cannot be approved afterwards
Risk: destructive · Irreversible
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
origin full type
origin full type
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
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
signingRequests full type
signingRequests full type
pagination full type
pagination full type
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
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
rsaOptions full type
rsaOptions full type
ecdsaOptions full type
ecdsaOptions full type
mldsaOptions full type
mldsaOptions full type
metadata full type
metadata full type
hashSigningData full type
hashSigningData full type
hashSigningResult full type
hashSigningResult full type
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
metadata full type
metadata full type
signingData full type
signingData full type
signingResult full type
signingResult full type
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
origin full type
origin full type
submitWithArtifactRetrievalLink
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
origin full type
origin full type
submitWithoutArtifact
signingRequests.submitWithoutArtifact
Submit a signing request before the artifact exists, returning the upload link the artifact must be delivered to
Risk: destructive
origin full type
origin full type
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
notificationEmailAddress full type
notificationEmailAddress full type