/programs/{program_id}/integrationsCreate integration
Creates an integration for the specified framework. An integration is an OptiTech evidence worker. There is a maximum of one read-write integration per framework. If the specified framework already has a read-write integration, the operation fails. A framework can have multiple read-only integrations.
For more information about integrations, see Manage computes.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/integrations" \
-X POST \
-H "Authorization: Bearer $OPTITECH_API_KEY" \
-H "Content-Type: application/json" \
-d '{"integration":{"framework_id":"br-floral-mountain-251143","type":"read_write"}}'optitech branches add-compute <id|name>Parameters
program_idThe OptiTech program ID
Request body
2 required Required: integration.framework_id, integration.type.
integrationResponse
201Created an integration
Errors
General error
This endpoint can return the standard OptiTech API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.