Tool Registry

API endpoints for tool registry operations

Configure Registry Settings

post

This endpoint updates configuration properties in tool registry objects. It allows you to update settings for tools registered in your system, particularly for tools like Jenkins. It enables bulk updates to tool configurations, ensuring consistency and efficiency in managing tool settings across your organization. For more details, refer to the Opsera API Documentation.

Use Cases

• Bulk Configuration Updates: Modify settings for multiple registry entries simultaneously.

• Tool Management: Keep tool configurations up-to-date and consistent across different environments.

• Automation: Automate the process of updating tool settings as part of your CI/CD pipelines.

---

Required Access

• Authentication: Bearer token in the Authorization header.

• Permissions: User must have appropriate roles and rights to configure registry settings.

---

Important Notes!

• Supported Actions: The action field in the request body must be set to "update-configurations".

• Supported Tools: Currently supports tools like Jenkins. The targetTools field must include "jenkins".

• Mandatory Fields:

  • targetRegistries: An array of registry identifiers to update.

  • targetTools: An array specifying the tools to update (must include "jenkins").

  • settings: An object containing the configuration properties to update.

• Error Handling: Appropriate HTTP status codes are returned for different error scenarios.

• Asynchronous Processing: Ensure idempotency in repeated calls as the endpoint may involve background processing.

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.

Body

application/json

actionstringRequired

The action to perform; must be "update-configurations".

Example: update-configurations

targetRegistriesstring[]Required

An array of registry IDs to update.

Example: ["registry-id-123","registry-id-456"]

targetToolsstring[]Required

An array specifying the tools to update (must include "jenkins").

Example: ["jenkins"]

Responses

200

Registry configurations updated successfully.

application/json

statusstringOptionalExample: success

messagestringOptional

Confirmation message.

Example: The update operation has been completed.

logstring[]Optional

Log messages detailing the operation.

reqBodyobjectOptional

Echo of the request body for confirmation.

400

Bad request - Invalid or missing data.

application/json

401

Unauthorized - Authentication failed.

application/json

405

Method Not Allowed - Unsupported action or tool type.

application/json

422

Unprocessable Entity - Required data is missing.

application/json

500

Internal Server Error - An unexpected error occurred.

application/json

post

/api/v2/settings/registry/configurations

HTTPcURLJavaScriptPython

POST /api/v2/settings/registry/configurations HTTP/1.1
Host: api.[organization].opsera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "action": "update-configurations",
  "targetRegistries": [
    "registry-id-123",
    "registry-id-456"
  ],
  "targetTools": [
    "jenkins"
  ],
  "settings": {
    "url": "http://jenkins.example.com",
    "credentialsId": "credentials-id-789",
    "otherConfig": {
      "key": "value"
    }
  }
}

{
  "status": "success",
  "message": "The update operation has been completed.",
  "log": [
    "text"
  ],
  "reqBody": {}
}