Skip to content
API Reference

Search is only available in production builds. Try building and previewing the site to test it out locally.

Launch tags

Create colored tags and attach them to launches.

Tags group launches in your dashboard. Each tag has a name and a color, and a launch can carry several. Your tags and each launch's tag_ids are listed with your launches.

Create a tag

Bearer JWT
POST /launch/tags/create-tag

Creates a launch tag.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying Each call creates a new tag, even with the same name. Look for it in tags from List the license's launches before sending it again.

Body parameters application/json

  • name string Required
    Tag name, up to 25 characters.
  • color string Required
    Color as #RRGGBB.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome.
  • tag_id integer
    ID of the new tag.

Errors

StatusCodeWhen and what to do
400 bad_request name is longer than 25 characters. Shorten name to 25 characters or fewer.
400 bad_request color is not # followed by six hex digits. Send color as #RRGGBB, for example #7C5CFF.

Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.

Web client proxima.launch.tags.createTag(name, color) src/lib/proxima/endpoints/launch/tags.ts

Update a tag

Bearer JWT
POST /launch/tags/update-tag

Renames and recolors a launch tag.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry A repeat sets the same name and color again.

Body parameters application/json

  • tag_id string Required
    Tag ID, as a string.
  • new_name string Required
    New name, up to 25 characters.
  • new_color string Required
    New color as #RRGGBB.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome.

Errors

StatusCodeWhen and what to do
400 bad_request new_name is longer than 25 characters. Shorten new_name to 25 characters or fewer.
400 bad_request new_color is not # followed by six hex digits. Send new_color as #RRGGBB, for example #22C55E.
404 not_found No tag with this tag_id belongs to your license. Use a tag id from tags in List the license's launches.

Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.

Web client proxima.launch.tags.updateTag(tagId, newName, newColor) src/lib/proxima/endpoints/launch/tags.ts

Delete a tag

Bearer JWT
POST /launch/tags/delete-tag

Deletes a launch tag.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry A repeat after a successful delete answers 404 with Tag not found.

Body parameters application/json

  • tag_id string Required
    Tag ID, as a string.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome.

Errors

StatusCodeWhen and what to do
404 not_found No tag with this tag_id belongs to your license, or it is already deleted. Use a tag id from tags in List the license's launches.

Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.

Web client proxima.launch.tags.deleteTag(tagId) src/lib/proxima/endpoints/launch/tags.ts

Tag launches

Bearer JWT
POST /launch/tags/tag-launches

Attaches a tag to one or more launches.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Launches that already carry the tag are skipped, so a repeat answers linked: 0.

Body parameters application/json

  • tag_id string Required
    Tag ID, as a string.
  • launch_ids array<string> Required
    Public IDs of the launches, as strings.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome.
  • linked integer
    Launches newly tagged. Launches that already carry the tag and IDs that do not belong to your license are skipped without an error.

Errors

StatusCodeWhen and what to do
400 bad_request launch_ids is empty. Send at least one launch ID in launch_ids.
404 not_found No tag with this tag_id belongs to your license. Use a tag id from tags in List the license's launches.

Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.

Web client proxima.launch.tags.tagLaunches(tagId, launchIds) src/lib/proxima/endpoints/launch/tags.ts

Untag launches

Bearer JWT
POST /launch/tags/untag-launches

Removes a tag from one or more launches.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry A repeat finds nothing left to remove and answers removed: 0.

Body parameters application/json

  • tag_id string Required
    Tag ID, as a string.
  • launch_ids array<string> Required
    Public IDs of the launches, as strings.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome.
  • removed integer
    Launches the tag was removed from. Launches without the tag and IDs that do not belong to your license are skipped without an error.

Errors

StatusCodeWhen and what to do
400 bad_request launch_ids is empty. Send at least one launch ID in launch_ids.
404 not_found No tag with this tag_id belongs to your license. Use a tag id from tags in List the license's launches.

Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.

Web client proxima.launch.tags.untagLaunches(tagId, launchIds) src/lib/proxima/endpoints/launch/tags.ts