Update jobs spaces

Base URL: https://{kibana_url}

POST /api/ml/saved_objects/update_jobs_spaces

Update a list of jobs to add and/or remove them from given spaces.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

Response

200

Indicates a successful call

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/ml/saved_objects/update_jobs_spaces
{
  "jobIds": [
    "test-job"
  ],
  "jobType": "anomaly-detector",
  "spacesToAdd": [
    "default"
  ],
  "spacesToRemove": [
    "*"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/ml/saved_objects/update_jobs_spaces" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "jobIds": [
      "test-job"
    ],
    "jobType": "anomaly-detector",
    "spacesToAdd": [
      "default"
    ],
    "spacesToRemove": [
      "*"
    ]
  }'

Generated from the API spec

Response

{
  "test-job": {
    "success": true,
    "type": "anomaly-detector"
  }
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/ml/saved_objects/update_jobs_spaces
{
  "jobIds": [
    "test-job"
  ],
  "jobType": "data-frame-analytics",
  "spacesToAdd": [
    "default"
  ],
  "spacesToRemove": [
    "*"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/ml/saved_objects/update_jobs_spaces" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "jobIds": [
      "test-job"
    ],
    "jobType": "data-frame-analytics",
    "spacesToAdd": [
      "default"
    ],
    "spacesToRemove": [
      "*"
    ]
  }'

Generated from the API spec

Response

{
  "test-job": {
    "success": true,
    "type": "anomaly-detector"
  }
}