Download OpenAPI specification:Download
API for managing integration metadata updates
Retrieve a list of all integration metadata update records with optional filtering and pagination
| limit | integer [ 1 .. 100 ] Default: 50 Maximum number of records to return |
| offset | integer >= 0 Default: 0 Number of records to skip for pagination |
| sort | string Field to sort by |
| order | string Default: "desc" Enum: "asc" "desc" Sort order (asc or desc) |
| filter | string Filter conditions in JSON format |
| search | string Search term for text fields |
{- "success": true,
- "data": [
- {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "name": "Update API Version",
- "description": "string",
- "targetIntegrations": [
- "string"
], - "metaUpdates": {
- "apiVersion": "v2.0",
- "timeout": 30000,
- "retryCount": 3
}, - "conditions": { },
- "status": "draft",
- "appliedAt": "2019-08-24T14:15:22Z",
- "appliedBy": "string",
- "affectedCount": 0,
- "rollbackData": { },
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
], - "total": 0
}Create a new integration metadata update with the provided data
| name required | string Name of the meta update |
| description | string Description of the meta update |
| targetIntegrations | Array of strings List of integration IDs to update |
required | object Metadata fields to update |
object Conditions for applying the update | |
| status | string Default: "draft" Enum: "draft" "ready" "applied" "failed" "cancelled" Status of the meta update |
object Additional metadata |
{- "name": "Update API Version",
- "description": "string",
- "targetIntegrations": [
- "string"
], - "metaUpdates": {
- "apiVersion": "v2.0",
- "timeout": 30000,
- "retryCount": 3
}, - "conditions": { },
- "status": "draft",
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "name": "Update API Version",
- "description": "string",
- "targetIntegrations": [
- "string"
], - "metaUpdates": {
- "apiVersion": "v2.0",
- "timeout": 30000,
- "retryCount": 3
}, - "conditions": { },
- "status": "draft",
- "appliedAt": "2019-08-24T14:15:22Z",
- "appliedBy": "string",
- "affectedCount": 0,
- "rollbackData": { },
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Retrieve a specific integration metadata update by its ID
| id required | string Integration meta update ID |
{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "name": "Update API Version",
- "description": "string",
- "targetIntegrations": [
- "string"
], - "metaUpdates": {
- "apiVersion": "v2.0",
- "timeout": 30000,
- "retryCount": 3
}, - "conditions": { },
- "status": "draft",
- "appliedAt": "2019-08-24T14:15:22Z",
- "appliedBy": "string",
- "affectedCount": 0,
- "rollbackData": { },
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Update an existing integration metadata update with new data
| id required | string Integration meta update ID |
| name required | string Name of the meta update |
| description | string Description of the meta update |
| targetIntegrations | Array of strings List of integration IDs to update |
required | object Metadata fields to update |
object Conditions for applying the update | |
| status | string Default: "draft" Enum: "draft" "ready" "applied" "failed" "cancelled" Status of the meta update |
object Additional metadata |
{- "name": "Update API Version",
- "description": "string",
- "targetIntegrations": [
- "string"
], - "metaUpdates": {
- "apiVersion": "v2.0",
- "timeout": 30000,
- "retryCount": 3
}, - "conditions": { },
- "status": "draft",
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "name": "Update API Version",
- "description": "string",
- "targetIntegrations": [
- "string"
], - "metaUpdates": {
- "apiVersion": "v2.0",
- "timeout": 30000,
- "retryCount": 3
}, - "conditions": { },
- "status": "draft",
- "appliedAt": "2019-08-24T14:15:22Z",
- "appliedBy": "string",
- "affectedCount": 0,
- "rollbackData": { },
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Apply a specific integration metadata update
| id required | string Integration meta update ID |
{- "success": true,
- "data": {
- "appliedAt": "2019-08-24T14:15:22Z",
- "affectedIntegrations": 0
}
}