Skip to main content

Platform API - Trigger Fleet

Overview​

Quickly trigger an existing fleet in Platform to run without waiting for completion

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Shipyard API KeySHIPYARD_API_KEYPasswordβœ…--The API key that Platform generated for you
Project IDSHIPYARD_API_PROJECT_IDAlphanumericβœ…--The project ID where the target fleet resides
Fleet IDSHIPYARD_API_FLEET_IDAlphanumericβœ…--The ID of the fleet to trigger

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: Shipyard API - Trigger Fleet
inputs:
SHIPYARD_API_KEY: null ## REQUIRED
SHIPYARD_API_PROJECT_ID: null ## REQUIRED
SHIPYARD_API_FLEET_ID: null ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '101'
- '102'
- '103'
- '104'
- '105'
- '106'
- '249'