Search

API endpoints for search operations

Search Tasks, Tools, and Pipelines

get

This endpoint performs a search operation across various entities like tasks, tools, and pipelines based on provided query parameters. It allows users to search by name, description, ID, and other attributes. For more details, refer to the Opsera API Documentation.

Supported Search Types

Type	Description	Common Use Cases
pipeline	Search CI/CD pipelines	Find build, deploy, or test pipelines by name or tags
task	Search automation tasks	Locate Git sync, SFDC sync, or scheduled tasks
registry	Search tool configurations	Find GitHub, AWS, Jenkins, SonarQube configurations

Use Cases

• Pipeline Discovery: Search for CI/CD pipelines by name, description, or tags (e.g., find all "production" pipelines).

• Task Management: Locate specific tasks like Git sync, Salesforce sync, or custom automation tasks.

• Tool Configuration: Find registered tools and integrations (GitHub, AWS, Jenkins, SonarQube, etc.).

• Filtering: Narrow down results using specific fields, categories, or regex patterns.

• Integration: Use search results to integrate with other systems or automate workflows.

• Audit & Compliance: Find resources by ownership, type, or configuration for audit purposes.

---

Required Access

• Authentication: Bearer token is required in the Authorization header.

• Permissions: User must have appropriate roles and rights to perform search operations.

---

Important Notes!

• Supported Types: The t (type) parameter must be one of task, pipeline, or registry.

• Required Parameters:

  • t (type): The entity type to search (task, pipeline, registry).

• Optional Parameters (Search):

  • s (search string): The term to search for. If omitted, returns all items of the specified type.

• Optional Parameters:

  • regex: Set to true to use regex search; defaults to false.

  • count: Number of records to return; defaults to 100.

  • field: Specific field to search within.

  • c (category): Category/type filter. For pipelines: pipeline type (e.g., sfdc, sdlc). For tools: tool identifier (e.g., github, jenkins). For tasks: task category (e.g., gitscraper, sync).

  • m (exact match field): Field for exact match search.

• Data Validation: All parameters are validated. Missing or invalid parameters will result in an error.

• Rate Limits: Be aware of any rate limits that may apply to this endpoint.

---

Search Examples

Search for pipelines by name:

GET /api/v2/search?s=build&t=pipeline&count=10

Returns pipelines containing "build" in their name or description.

Search for tasks with regex pattern:

GET /api/v2/search?s=^sync.*&t=task&regex=true

Returns tasks whose names start with "sync" using regex matching.

Search for tools/registry by specific field:

GET /api/v2/search?s=github&t=registry&field=name

Searches only in the "name" field of tool registry entries.

Filter pipelines by type:

GET /api/v2/search?t=pipeline&c=sfdc

Returns all Salesforce pipelines.

Filter tools by tool identifier:

GET /api/v2/search?t=registry&c=github

Returns all GitHub tool registry entries.

Filter tasks by category:

GET /api/v2/search?t=task&c=gitscraper

Returns all Git Scraper tasks.

Combined search + filter:

GET /api/v2/search?s=deploy&t=pipeline&c=sdlc

Returns SDLC pipelines containing "deploy".

Exact match search by ID:

GET /api/v2/search?s=64d7c869b5760b001e46c1a2&t=pipeline&m=_id

Returns exact match for the specified pipeline ID.

Search for AWS tools:

GET /api/v2/search?s=aws&t=registry&count=20

Returns all AWS-related tool configurations.

List all pipelines (no search term):

GET /api/v2/search?t=pipeline

Returns all pipelines accessible to the authenticated user.

List all tasks (no search term):

GET /api/v2/search?t=task

Returns all tasks accessible to the authenticated user.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Query parameters

sstringOptional

The search string or term. If omitted, returns all items of the specified type.

Example: build

tstring · enumRequired

The type of entity to search.

Example: pipelinePossible values:

regexbooleanOptional

Set to true to perform a regex search.

Default: falseExample: false

countinteger · min: 1 · max: 1000Optional

The number of records to return.

• Default: 100
• Maximum: 1000
• Use smaller values for faster responses

Default: 100Example: 50

fieldstringOptional

Specific field to search within. Common fields include:

• name - Search only in resource names
• description - Search only in descriptions
• tags - Search only in tags
• owner - Search by owner email

Example: name

cstringOptional

Category/type filter. Behavior depends on the t parameter:

• For t=pipeline: Pipeline type. Valid values: apigee, azure_openai, boomi, github_actions_pipeline, informatica, ai-ml, oracle_fusion, sfdc, sap-cpq, sdlc, servicenow
• For t=registry: Tool identifier. Valid values: github, gitlab, bitbucket, jenkins, sonar, jira, aws_account, azure, slack, teams, snyk, anchore, twistlock, coverity, terraform, argo, hashicorp_vault, etc.
• For t=task: Task category. Valid values: gitscraper, sync, sfdc-configurator, etc. Invalid values will return an error with supported types listed.

Example: sfdc

mstringOptional

Field for exact match search (case-sensitive). Use this when you know the exact value. Common fields: _id, name, toolIdentifier, taskType

Example: _id

Responses

200

Successfully retrieved search results.

application/json

totalCountintegerOptional

Total number of results found.

Example: 150

400

Bad Request - Invalid or missing input data.

application/json

401

Unauthorized - Authentication failed or insufficient permissions.

application/json

422

Unprocessable Entity - Invalid or missing data provided.

application/json

500

Internal Server Error - An unexpected error occurred.

application/json

get

/api/v2/search

HTTPcURLJavaScriptPython

GET /api/v2/search?t=task HTTP/1.1
Host: api.[organization].opsera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 3,
  "results": [
    {
      "_id": "64d7c869b5760b001e46c1a2",
      "name": "Production Build Pipeline",
      "description": "CI/CD pipeline for production builds",
      "type": "pipeline",
      "tags": [
        "production",
        "build",
        "ci-cd"
      ],
      "active": true,
      "owner": "[email protected]"
    },
    {
      "_id": "64d7c869b5760b001e46c1a3",
      "name": "Build and Deploy Pipeline",
      "description": "Automated build and deployment workflow",
      "type": "pipeline",
      "tags": [
        "build",
        "deploy"
      ],
      "active": true,
      "owner": "[email protected]"
    },
    {
      "_id": "64d7c869b5760b001e46c1a4",
      "name": "Staging Build Pipeline",
      "description": "Pipeline for staging environment builds",
      "type": "pipeline",
      "tags": [
        "staging",
        "build"
      ],
      "active": true,
      "owner": "[email protected]"
    }
  ]
}