Shipyard API - Export Logs

Overview

First time using this Blueprint? Make sure you follow our Shipyard API authorization guide.

Quickly download the logs of your Shipyard Organization. The file contents will be downloaded and available as a CSV to use in another vessel.

Variables

Name	Reference	Type	Required	Default	Options	Description
Shipyard API Key	SHIPYARD_API_KEY	Password	✅	-	-	The API key that Shipyard generated for you
File Name	SHIPYARD_FILE_NAME	Alphanumeric	✅	shipyard_logs.csv	-	The name of the csv file you would like the logs to be saved as.
Folder Name	SHIPYARD_FOLDER_NAME	Alphanumeric	➖	-	-	The name of the folder where the logs will be downloaded to. If left blank, the file will be downloaded in the root directory

YAML

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

source:
  blueprint: Shipyard API - Export Logs
  inputs:
    SHIPYARD_API_KEY: null ## REQUIRED
    SHIPYARD_FILE_NAME: shipyard_logs.csv ## REQUIRED
    SHIPYARD_FOLDER_NAME: null 
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0s
  runtime_cutoff: 4h0m0s
  exclude_exit_code_ranges:
    - "201-202"