Documentation

Getting started

Last updated

1. Create an account

Create one Farshore Labs account at /signup using your work email. Verify the address from the link in the welcome email; some actions (creating API keys, activating paid services) are blocked until your address is verified.

2. Activate a service

Open the catalog and choose a service. On first activation Farshore opens a Stripe Setup Intent so you can store a payment method; subsequent activations reuse the same method automatically. Most services start at $15/month or $50/year per user; specialized services may use custom pricing shown on their catalog tile.

3. Create an API key

Go to Account › API keys and click Create key. Name the key, scope it to the services you actually need (recommended over “any service”), and optionally set an expiry. The full token — a string starting with fsl_live_ — is shown once. Copy it into a secrets manager immediately; we cannot recover it.

4. Make your first call

Pass the token as a Bearer credential on the Authorization header. Example, using the Azure availability service:

curl https://api.farshorelabs.com/azure-availability/v1/availability \
  -H "Authorization: Bearer fsl_live_********************************************" \
  -G \
  --data-urlencode "service=Microsoft.Compute/virtualMachines" \
  --data-urlencode "sku=Standard_D4s_v5" \
  --data-urlencode "region=eastus2"

The response is JSON, the rate-limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) tell you how much of your monthly quota is left, and any failures follow the documented error format.

What next