COcognigy
Extensions

Update an Extension

Updates an existing uploaded Extension in a Project by replacing it with a new version. You can provide the Extension either as a file upload or via a URL. The method creates a Task to process the update, and the response returns the task status and progress so you can track when the replacement is completed.

post/v2.0/extensions/update

Request

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

urlstring url required

The url to an extension. The Extension will then loaded by the system.

projectIdstring required

The Id of the project.

extensionstring required

The name of the extension to update.

Example request

{
  "url": "https://github.com/Cognigy/Extensions/releases/download/random-cat-image400/random-cat-image.tar.gz"
}

Response

Create a Task to delete the Extension if already present and replace it with the uploaded Extension.

_idstring
status'queued' | 'active' | 'done' | 'cancelling' | 'cancelled' | 'error'

The status of the task

typestring
parametersobject
lastChangedAtnumber
lastCreatedAtnumber
currentStepinteger
totalStepinteger

Example response

{
  "status": "queued",
  "type": "trainIntents",
  "lastChangedAt": 1594243850,
  "lastCreatedAt": 1594243850,
  "totalStep": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.