Skip to navigation
API ReferenceLinks

Create

Add a link to a launch. Needs artifacts:write.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

launchIdstringRequired

Request

This endpoint expects an object.
titlestringRequired
Up to 200 characters.
urlstringRequired

http or https; a bare domain, such as docs.acme.com/spec, gets https:// in front.

descriptionstringOptional
Up to 1,000 characters.

Response

This endpoint returns an object.
idstring
launchIdstring
titlestring
urlstring
Always http or https.
createdAtdatetime
updatedAtdatetime
descriptionstringOptional
A line on what it is.
createdByobjectOptional

Whoever added it; null when the key that added it belongs to nobody.

Errors

403
Forbidden Error
404
Not Found Error
422
Validation Error
429
Too Many Requests Error