Skip to main content
PUT
/
storage
/
models
/
{uuid}
Update model
curl --request PUT \
  --url https://api.getcargo.io/v1/storage/models/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "extractorSlug": "<string>",
  "position": {
    "x": 123,
    "y": 123
  },
  "config": {},
  "schedule": {
    "type": "<string>",
    "jobId": "<string>"
  }
}
'
{
  "model": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "datasetUuid": "<string>",
    "extractorSlug": "<string>",
    "position": {
      "x": 123,
      "y": 123
    },
    "config": {},
    "schedule": {
      "type": "<string>",
      "jobId": "<string>"
    },
    "meta": {},
    "columns": [
      {
        "slug": "<string>",
        "type": "string",
        "label": "<string>",
        "kind": "<string>",
        "originalSlug": "<string>",
        "properties": [
          "<string>"
        ],
        "description": "<string>"
      }
    ],
    "additionalColumns": [
      {
        "slug": "<string>",
        "type": "string",
        "label": "<string>",
        "kind": "<string>",
        "properties": [
          "<string>"
        ],
        "description": "<string>"
      }
    ],
    "idColumnSlug": "<string>",
    "uniqueColumns": [
      "<unknown>"
    ],
    "unificationType": "<string>",
    "titleColumnSlug": "<string>",
    "timeColumnSlug": "<string>",
    "playsCount": 123,
    "segmentsCount": 123,
    "isPaused": true,
    "lastEmittedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "lastRun": {
      "uuid": "<string>",
      "status": "pending",
      "errorMessage": "<string>",
      "createdAt": "<string>",
      "finishedAt": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string
required

Resource UUID

Body

application/json

Request body schema.

name
string

Model name.

extractorSlug
string

Extractor identifier.

position
Position · object

Model position in the canvas.

config
Config · object

Model configuration.

schedule
Schedule · object

Model schedule configuration.

Response

Successful response

model
Model · object
required

Updated model details.