Does the OpsIQ API support idempotency?
Yes, the developer model includes idempotent replay protection for writes. This feature includes a documented 24-hour idempotency window for supported operations. Clients should reuse the same key when retrying the same…
How are OpsIQ outbound webhooks signed?
OpsIQ signs outbound webhook payloads using HMAC-SHA256 over the raw request body. It also includes delivery metadata such as the timestamp and event. Receivers should follow these steps: Calculate the signature from…
How many operations are available through the OpsIQ General API?
The current developer and integrations pages describe 1,558 named General API operations governed by 62 least-privilege scopes. The operation registry ensures that API behavior, action documentation, scopes, and…
Does the OpsIQ API support dry-run requests?
Yes, the OpsIQ API supports dry-run requests. Supported operations can utilize the dry_run behavior, allowing integrators to validate intent and parameters without committing the write. This feature is particularly…
What SDK and API reference formats does OpsIQ provide?
OpsIQ provides an OpenAPI 3.0.3 description, Postman resources, and helper patterns for PHP, Node.js, and Python. This allows teams to integrate with their preferred technology stack instead of relying on a single…
Can I temporarily disable an API token without deleting it?
Yes, API Tokens support disabling and later re-enabling a token. You can disable a token when an integration should temporarily stop using it. Please remember that the connected integration will fail authentication…
How does API rate limiting work in OpsIQ?
OpsIQ applies API rate limits per key and returns rate-limit information in the response headers. When a limit is exceeded, clients receive an HTTP 429 status code along with guidance on when to retry through the…
What information can I see about an API token?
The API Tokens page provides various details about each token, including: Token Name Public Identifier Granted Permissions Current Status Usage Information (e.g., when it was last used) Note that the secret itself is…
Why can't I see my API token secret again?
The token secret is intentionally shown only at the time of creation. The account stores what it needs to verify future token use, rather than a reusable clear-text copy for later display. If you lose the secret, you…
How do I authenticate to the OpsIQ General API?
Authenticating to the OpsIQ General API OpsIQ's General API utilizes scoped Bearer API keys. It is important that these keys are assigned only the least-privilege scopes necessary for their function. Additionally, they…
What happens when I delete an API token?
Deleting a token permanently removes that customer token from active use. Any integration still configured with it will stop authenticating and must be updated with a new token if access is still required. If you want a…
What are customer API tokens in OpsIQ?
Customer API tokens allow you to authorize supported customer-scoped integrations without sharing your account password. These tokens can carry limited permissions for supported account, license, billing, or support…
How do I create an OpsIQ customer API token?
To create an OpsIQ customer API token, follow these steps: Open the API Tokens section. Create a token with a descriptive name. Select the appropriate available permissions. After the token is created, copy the secret…
Can I use an OpsIQ API token instead of my account password for an integration?
Yes, you can use an OpsIQ API token instead of your account password for supported customer API operations. This method is preferable to providing an integration with your interactive account password because the token…