API

A REST or GraphQL API endpoint that provides programmatic access to platform resources, data, and operations for integrations and automations.

Properties

• id (string): Unique identifier for the API endpoint.
• name (string): The descriptive name identifying this API.
• type (string): API type (rest, graphql, rpc, websocket, grpc).
• description (string): A comprehensive explanation of the API's purpose and capabilities.
• url (string): The base URL or endpoint path for the API.
• method (string): The HTTP method for REST APIs (GET, POST, PUT, PATCH, DELETE).
• version (string): The API version number (e.g., 'v1', 'v2', '2024-01-01').
• status (string): The current operational state (active, deprecated, beta, testing, disabled).
• authentication (string): Authentication method required (apiKey, oauth2, bearer, basic, none).
• headers (object): Required or recommended HTTP headers.
• parameters (object[]): Query parameters, path parameters, or request body schema.
• requestSchema (object): JSON schema defining valid request structure.
• responseSchema (object): JSON schema defining response structure.
• rateLimit (number): Maximum number of requests allowed per time window.
• rateLimitWindow (number): Time window for rate limiting in seconds.
• timeout (number): Maximum request processing time in milliseconds.
• retryable (boolean): Whether failed requests can be safely retried.
• idempotent (boolean): Whether multiple identical requests produce the same result.
• integration ([[Integration]]): The integration this API belongs to.
• documentation (string): URL to API documentation or OpenAPI specification.
• enabled (boolean): Whether the API endpoint is currently enabled.
• requestCount (number): Total number of requests made to this API.
• successCount (number): Number of successful API requests.
• errorCount (number): Number of failed API requests.
• averageLatency (number): Average response time in milliseconds.
• metadata (object): Set of key-value pairs for storing additional information.

Actions

create

Create a new API endpoint with schema and configuration.

Input: [[API]]
Output: [[API]]

update

Modify API configuration, schema, or operational parameters.

Input: [[API]]
Output: [[API]]

delete

Permanently remove the API endpoint.

Input: [[API]]
Output: [[API]]

enable

Activate the API endpoint to accept requests.

Input: [[API]]
Output: [[API]]

disable

Deactivate the API endpoint to reject requests.

Input: [[API]]
Output: [[API]]

deprecate

Mark API as deprecated and set sunset date.

Input: [[APIDeprecation]]
Output: [[API]]

call

Execute API request and return response.

Input: [[APIRequest]]
Output: [[APIResponse]]

validate

Validate request against API schema.

Input: [[APIValidation]]
Output: [[APIValidationResult]]

test

Test API endpoint with sample requests.

Input: [[APITest]]
Output: [[APITestResult]]

monitor

Track usage, performance, errors, and rate limits.

Input: [[API]]
Output: [[APIMetrics]]

Events

• created: Triggered when a new API endpoint is created.
• updated: Triggered when API configuration is modified.
• deleted: Triggered when an API endpoint is permanently removed.
• called: Triggered when API endpoint receives a request.
• deprecated: Triggered when API is marked as deprecated.
• disabled: Triggered when API endpoint is deactivated.
• enabled: Triggered when API endpoint is activated.
• Error.occurred: Triggered when API request fails or returns error.
• RateLimit.exceeded: Triggered when request exceeds rate limit.
• Request.completed: Triggered when API request completes successfully.
• Request.timeout: Triggered when API request exceeds timeout limit.
• Validation.failed: Triggered when request fails schema validation.