Update Integration Meta API (1.0.0)

Download OpenAPI specification:Download

API for managing integration metadata updates

Update Integration Meta

Operations related to updating integration metadata

Get all integration meta update records

Retrieve a list of all integration metadata update records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new integration meta update

Create a new integration metadata update with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "name": "Update API Version",
  • "description": "string",
  • "targetIntegrations": [
    ],
  • "metaUpdates": {
    },
  • "conditions": { },
  • "status": "draft",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get integration meta update by ID

Retrieve a specific integration metadata update by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration meta update ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update integration meta update

Update an existing integration metadata update with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration meta update ID

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "name": "Update API Version",
  • "description": "string",
  • "targetIntegrations": [
    ],
  • "metaUpdates": {
    },
  • "conditions": { },
  • "status": "draft",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete integration meta update

Delete an existing integration metadata update

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration meta update ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Integration meta update deleted successfully"
}

Apply integration meta update

Apply a specific integration metadata update

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Integration meta update ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}