Start from a ready API template

Make a working project, suite or monitor on the built-in sandbox in one press.

In short

A template makes something that already works: it runs against the built-in sandbox API, so a new account gets a first real result at once. Pick one, name it and it opens ready to run. Rename it, change it or delete it afterwards like anything you made by hand.

Before you start

• Who: signed in, with the right to add to the workspace you chose. If you only view it, "Use template" is not shown.
• Plan: the project, suite or monitor counts against your plan's limits. The "Uptime monitor" needs monitoring on your plan; Free allows basic monitors.
• First: choose the workspace in the header. The template is made there, in "Goes into".

Steps

1. Open "Templates" in the workspace menu, or "Start anything" at the foot of the Products menu. On an empty "Suites" or "Monitors" screen, "Use a template" opens it too.
2. In "Show templates for", choose "API Tester".
3. Press "Use template" on the one you want. A sheet "Use ..." shows its "Name" and "Goes into" your workspace.
4. Press "Create". The project, suite or monitor is made and opens.

Result: the suite or project is there with its requests and checks, and the first run passes against the sandbox.

The seven templates

Good to know

• Everything points at the sandbox, so every template works on a fresh account. Change the environment's base URL to test your own API.
• A template is made the way you would make it by hand: your plan's limits and your access apply, and it is made whole or not at all.
• The OAuth template leaves the client id and secret for you to fill in as environment variables; the secret is never shown again once saved.
• The Uptime monitor needs monitoring on your plan. Free allows basic monitors; see /help/api-testing/monitors-and-alerts.
• What happens next: the new project, suite or monitor opens at once and belongs to the workspace. Rename it, change it or delete it like anything you made by hand.

If something goes wrong

• The template cannot be made and a plan limit is named: you have reached your plan's limit for projects, suites or monitors. Free some room or change the plan.
• You cannot see "Use template": you can view this workspace but not add to it. Ask an admin, or use your Personal Workspace.

Related

• /help/api-testing/test-suites
• /help/api-testing/monitors-and-alerts
• /help/api-testing/start-here
• /help/home/templates-and-recipes