API Overview
StackGuardian APIs use predictable resource-oriented URLs, accept JSON-encoded request payloads, and return JSON-encoded responses. The API employs standard HTTP response codes and verbs.
Base URL: https://api.app.stackguardian.io/api/v1
Authentication
Authenticate against the StackGuardian API using an API Key. Generate the API Key in your Organization's settings, then pass it in the Authorization HTTP header:
Authorization: apikey <API_KEY>
Steps to Generate an API Key
1. Access Organization Settings
- Navigate to your organization settings by clicking "Profile" > "Settings".
2. Open API Key Tab
- In the settings menu, locate and open the "API Key" tab.
3. Generate and Copy the API Key
- Click "View" or "Regenerate" to create a new API Key.
- Copy the key securely for use in API requests.
Errors
StackGuardian APIs follow standard HTTP response codes:
| Status Code | Description |
|---|---|
| 200 - OK | Request was successful. |
| 204 - OK | Request was successful, but no content to return. |
| 400 - Bad Request | Request was invalid due to missing or incorrect parameters. |
| 401 - Unauthorized | Invalid or expired API Key. |
| 403 - Forbidden | Access to the requested resource is not permitted. |
| 404 - Not Found | Resource does not exist. |
| 5xx - Server Error | Server encountered an issue. Please report it to support. |
Reporting Issues
If you encounter any issues:
- Email us at team@stackguardian.io
- Connect with us on Slack