Pipelines
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
An array of pipeline identifiers to be processed.
["pipeline-123","pipeline-456"]Additional YAML configuration parameters.
YAML document received and processed successfully.
successA YAML document has been received.The parsed YAML content received in the request.
Parsed token data from the request.
Bad request - Invalid or missing data provided.
Unauthorized - Authentication failed.
Unprocessable Entity - Invalid or missing data provided.
Internal Server Error.
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
The action to perform; must be "update-source".
update-sourceAn array of pipeline IDs to update.
["pipeline-id-123","pipeline-id-456"]An array of tool IDs associated with the pipelines.
["tool-id-789","tool-id-012"]Source repository settings updated successfully.
successConfirmation message.
Source repository settings updated successfully.Bad request - Invalid or missing data.
Unauthorized - Authentication failed.
Method Not Allowed - Unsupported action.
Unprocessable Entity - Required data is missing.
Internal Server Error - An unexpected error occurred.
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
List of pipeline IDs to be deleted.
["pipeline1-id","pipeline2-id"]Pipelines deleted successfully.
Status of the operation.
successConfirmation message of the deletion.
The action has been completed.Log messages from the deletion process.
Pipeline pipeline1-id deleted.Invalid or missing input data.
Unauthorized access - Invalid or missing token.
Internal server error.
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
List of pipeline IDs to be executed.
["pipeline1-id","pipeline2-id"]Successfully executed the pipelines.
Status of the pipeline execution.
successLog of activities performed during pipeline execution.
["Pipeline started successfully.","Deployment completed."]Bad Request - Invalid or missing input data.
Unauthorized - Missing or invalid authentication.
Internal Server Error - An unexpected error occurred.
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
Page number (1-based)
1Number of items per page (clamped to max 200)
50Keyword search across pipeline name and description
Filter pipelines by last run status
Pipelines retrieved successfully
Number of pipelines in this page
Authentication failed
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
Pipeline name
E2E Test Pipeline CreationOptional pipeline description
Pipeline type/category classifications (e.g., ["sfdc", "ci-cd"]). Used to determine pipeline behavior and step processing.
["ci-cd"]Pipeline created successfully
Response status indicator
Bad Request - validation errors
Authentication failed
Access denied
Unprocessable Entity - dependency validation failed
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
MongoDB ObjectId of the pipeline
Pipeline details retrieved successfully
1Invalid pipeline ID format or pipeline not found
Authentication failed
Insufficient permissions
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
MongoDB ObjectId of the pipeline
Number of recent runs to return (clamped to 5-10)
5Recent pipeline runs retrieved successfully
5Invalid pipeline ID format
Authentication failed
Insufficient permissions
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
MongoDB ObjectId of the pipeline
Numeric run count identifier for the pipeline run
Pipeline run status retrieved successfully
1Invalid pipeline ID or run count format, or pipeline not found
Authentication failed
Insufficient permissions
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
Accepts id or name, or nested identifier object with id/name
MongoDB ObjectId
Resource name (not guaranteed to be unique)
Pipeline execution started successfully
Response status indicator
Authentication failed
Access denied
Pipeline not found
Resource conflict (e.g., pipeline already running or ambiguous identifier)
Unprocessable Entity - missing id/name or validation errors
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
Array of pipeline IDs to update. Mutually exclusive with folderPath.
At least one of pipelineIds or folderPath must be provided.
["507f1f77bcf86cd799439011","507f1f77bcf86cd799439012"]Folder path to select all pipelines within that folder. Mutually exclusive with pipelineIds.
At least one of pipelineIds or folderPath must be provided.
/production/ci-cdWhen true (default), replaces all existing roles with the provided roles.
When false, appends the provided roles to existing roles without duplicates.
trueBulk RBAC update completed (may include partial failures)
Response status indicator
Bad Request - Validation error
Unauthorized - Authentication required
Forbidden - Insufficient permissions (requires Administrator, Power User, or Opsera Administrator role)
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
Pipeline name
Validated CI/CD PipelineOptional pipeline description
Pipeline type/category classifications (e.g., ["sfdc", "ci-cd"]). Used to determine pipeline behavior and step processing.
["ci-cd"]Pipeline created successfully with validated steps
Response status indicator
Bad Request - Missing required fields or validation errors
Authentication failed
Access denied (UPDATE mode only) - User doesn't have permission to update this pipeline
Pipeline Not Found (UPDATE mode only) - Invalid or non-existing pipeline ID
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
The unique identifier for the pipeline step tool.
Case-insensitive - Accepts values like "docker-push", "Docker-Push", or "DOCKER-PUSH".
Use the standard values from /api/v2/tools/identifiers (e.g., "docker-push", not "docker_push").
docker-pushMetadata retrieved successfully with AI context
Bad Request - Missing, invalid, or unknown tool identifier
Authentication failed
Access denied
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
Pipeline name
Node.js API PipelineOptional pipeline description
Pipeline type/category classifications (e.g., ["sfdc", "ci-cd"]). Used to determine pipeline behavior and step processing.
["ci-cd"]Validation completed (check valid field for result)
Authentication failed
Access denied
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
Page number for pagination
1Number of items per page
25Sort order for results
newestPossible values: Keyword search in template name and description
Filter by template type
Filter by template status
Pipeline templates retrieved successfully
Response status indicator
Bad request (e.g., invalid token)
Access denied
Internal server error
API authentication using Bearer tokens. Include your API token in the Authorization header:
Authorization: Bearer <your-api-token>
Tokens can be obtained from the Opsera platform's API token management interface.
Pipeline template ID (24-character alphanumeric string)
64d7c869b5760b001e46c1a2Pattern: ^[a-zA-Z0-9]{24}$Pipeline template retrieved successfully
Response status indicator
Bad Request (invalid template ID or token)
Access denied
Not Found - Template does not exist
Internal server error
Last updated

