Skip to content
Helmsman
Menu

Get started

Get started

Look at public records first, then sign in when you need to change something.

  1. Step 1

    Search public records

    Call GET /api/v1/search?q=<term> with no credentials. It returns Applications, Agents, Processes and other resources whose Mode lets everyone read them.

  2. Step 2

    Sign in

    Sign in with your Fleetworks account to see what your Organization owns and to change what your Org role allows.

  3. Step 3

    Mint a PAT for automation

    An org admin creates a Service account and its PAT. Send it as a bearer token; it starts with wl_.

  4. Step 4

    Report delivery from CI

    Post Pipeline runs, Deployments and Commit statuses from your pipelines with that PAT.

What you need

  • Nothing to search public records: any HTTP client works
  • A Fleetworks account and an Org role to sign in and change records
  • An org admin to create Service accounts and their PATs