Connect a small integration to the REST API

Build the first REST API test with a disposable workspace and an environment-held key. Copy endpoint paths and request fields from the current reference rather than guessing them.

Before you start

• Use a disposable workspace and non-confidential test file.
• Choose the smallest permissions and surfaces the task requires.
• Prepare a password manager or secret store; never place a real key in a screenshot, URL or repository.
• Plan to revoke the test key after verification.

Steps: connect a small integration to the rest api

1. Open Integrations → REST API and the current API reference.
2. Create a narrowly scoped key for the test workspace.
3. Store the secret in an environment variable or secret manager.
4. Send a documented harmless listing request over HTTPS.
5. Check the structured response and request identifier when present.
6. Test one known denied operation, then revoke the disposable key.

Expected result

The test key performs its allowed operation, rejects an operation outside its boundary, and can be identified and revoked without changing the account password.

Limits and important details

• Use only endpoints and fields in the current reference.
• Keep secrets out of query strings, source control and logs.
• Handle rate, quota and network errors explicitly; do not retry every response indefinitely.

Troubleshooting

The request returns unauthorized. Check the complete secret, API endpoint and whether the key was revoked.

The request returns forbidden. Compare the operation with the key permission, protocol surface, workspace and folder anchor.

A secret was exposed. Revoke it immediately, create a replacement with least privilege and remove the exposed value from logs and history.

Related guides

• Create an API key
• Choose key permission
• Revoke a key