REST templates

REST templates provide connection starters and allow you to reuse OpenAPI specifications across your workspace. You can find them under Settings > APIs > API Specs.

Templates can include endpoint structure, default headers, static variables, and suggested auth.

What templates usually include

Templates can provide:

• Base URL defaults
• Suggested endpoints
• Required static variables such as owner, repo, or project identifiers
• Suggested auth patterns
• Template collections with child APIs for the same provider

Template content can still be edited after creation.

Custom REST templates

You can upload your own OpenAPI 2.0 or 3.0 schemas (JSON or YAML) to create custom templates. This allows you to standardize API connections across your workspace without manually configuring the same endpoints repeatedly.

📘

Importing, updating, and deleting custom OpenAPI specifications requires administrator access. Workspace builders can create connections from imported templates, but cannot add, edit, or delete specs.

Importing a custom spec

1. Go to Workspace Settings > APIs > API Specs.
2. Click Import OpenAPI spec.
3. Provide a name and description.
4. Upload your .json or .yaml file.
5. Click Import.

Once imported, your spec will appear in the Imported API specs section, where administrators can update the metadata or delete it if it is not in use.

Create a connection from a template

1. Open Workspace Settings > APIs > API Specs
2. Locate the desired template in the Imported or Pre-built sections.
3. Click Connect next to the template name.
4. Set a clear Display name for the connection.
5. If prompted, select the specific API in the template collection
6. In Credentials, verify:
   • Base URL
   • URL parameters
   • Headers
   • Static variables
7. In Authentication, add required auth config
8. Click Save

Shared vs independent template collections

Some template collections include child APIs and use one of two connection modes:

• Shared: child APIs share connection settings such as base URL and auth
• Independent: each child API is treated as its own connection choice

Validate the template connection

1. Click Open in API Editor
2. Open a template query
3. Fill required bindings
4. Click Send
5. Confirm expected response
6. Click Save Query

Troubleshooting template setup

• 401/403 after template import: auth is missing or invalid
• 404 on a template query: the base URL or path does not match the target service
• Empty response: required bindings are missing or have the wrong defaults
• Template variable locked or required: ensure the value exists in Credentials > Static Variables
• Missing endpoint list for a child API: confirm the correct child API is selected

When to use Create custom instead

Use Create custom connection when:

• Your API is not covered by existing templates and you do not have an OpenAPI spec to import.
• You need custom request/response shaping from the start
• You want to define naming conventions and query layout manually

Related guides

• REST API
• REST queries
• REST authentication
• REST variables