Skip to main content
PATCH
/
api
/
datasets
/
{dataset_id}
/
settings
Update Dataset Settings
curl --request PATCH \
  --url https://api.example.com/api/datasets/{dataset_id}/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "branch_name": "<string>",
  "webhook_url": "<string>",
  "repo_url": "<string>",
  "repo_access_token": "<string>",
  "clear_repo_access_token": true,
  "webhook_on_complete": true,
  "webhook_on_failure": true,
  "integrations": {},
  "dataset_type": "<string>",
  "dimension": "<string>",
  "engine_overrides": {},
  "off_topic_collective": true,
  "excluded_patterns": [
    "<string>"
  ],
  "permissions": {
    "view": {
      "users": [
        123
      ],
      "roles": [
        "<string>"
      ]
    },
    "edit": {
      "users": [
        123
      ],
      "roles": [
        "<string>"
      ]
    }
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "size_bytes": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "last_scan_at": "<string>",
  "vulnerabilities": 123,
  "vulnerability_types": "<string>",
  "scan_error": "<string>",
  "branch_name": "main",
  "is_main_branch": true,
  "branch_family_uuid": "<string>",
  "source_branch_uuid": "<string>",
  "branch_origin": "<string>",
  "branch_count": 1,
  "owner_id": 123,
  "permissions": {
    "view": {
      "users": [
        123
      ],
      "roles": [
        "<string>"
      ]
    },
    "edit": {
      "users": [
        123
      ],
      "roles": [
        "<string>"
      ]
    }
  },
  "can_edit": false,
  "scans": [
    {
      "id": "<string>",
      "scan_type": "<string>",
      "dataset_dir": "<string>",
      "params": {},
      "status": "<string>",
      "progress": 123,
      "message": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "dataset_id": "<string>",
      "dataset_name": "<string>",
      "engine_params": {},
      "started_at": "<string>",
      "finished_at": "<string>",
      "duration_seconds": 123,
      "total_issues": 0,
      "critical_count": 0,
      "high_count": 0,
      "medium_count": 0,
      "low_count": 0
    }
  ],
  "valid_images": 123,
  "invalid_images": 123,
  "document_count": 123,
  "class_count": 123,
  "classes": [
    "<string>"
  ],
  "image_specificity": "fine",
  "active_scan_progress": 123,
  "active_scan_elapsed_seconds": 123,
  "active_scan_message": "<string>",
  "active_scan_started_at": "<string>",
  "active_scan_id": "<string>",
  "active_scan_status": "<string>",
  "active_scan_type": "<string>",
  "issue_type": "<string>",
  "webhook_url": "<string>",
  "repo_url": "<string>",
  "repo_requires_auth": true,
  "has_repo_access_token": false,
  "webhook_on_complete": false,
  "webhook_on_failure": false,
  "queued_scan_count": 0,
  "issue_counts": {
    "mislabel": 0,
    "poison": 0,
    "outlier": 0,
    "bias": 0,
    "shortcut": 0,
    "flagged": 0
  },
  "latest_mislabel_scan_id": "<string>",
  "processing": false,
  "processed_3d": true,
  "import_job_id": "<string>",
  "import_provider": "<string>",
  "import_status": "<string>",
  "import_progress": 123,
  "import_message": "<string>",
  "import_error": "<string>",
  "import_cancel_requested": false,
  "import_updated_at": "<string>",
  "import_has_stored_credentials": false,
  "import_can_retry": false,
  "dense_branch_build": {}
}

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Path Parameters

dataset_id
string
required

Cookies

antidote_session
string | null

Body

application/json
name
string | null
branch_name
string | null
webhook_url
string | null
repo_url
string | null
repo_access_token
string | null
clear_repo_access_token
boolean | null
webhook_on_complete
boolean | null
webhook_on_failure
boolean | null
integrations
Integrations · object
image_specificity
enum<string> | null
Available options:
fine,
broad
dataset_type
string | null
dimension
string | null
engine_overrides
Engine Overrides · object
off_topic_collective
boolean | null
excluded_patterns
string[] | null
permissions
PermissionsPayload · object

Response

Successful Response

id
string
required
name
string
required
type
string | null
required
size_bytes
integer
required
created_at
string | null
required
updated_at
string | null
required
last_scan_at
string | null
required
status
enum<string>
required
Available options:
UPLOADING,
UNSCANNED,
IN_QUEUE,
SCANNING,
SCANNED,
QUARANTINED,
STOPPED,
FAILED
severity
enum<string>
required
Available options:
UNSCANNED,
HEALTHY,
UNHEALTHY-,
UNHEALTHY+,
CRITICAL
vulnerabilities
integer | null
required
vulnerability_types
string | null
required
scan_error
string | null
required
branch_name
string
default:main
is_main_branch
boolean
default:true
branch_family_uuid
string | null
source_branch_uuid
string | null
branch_origin
string | null
branch_count
integer
default:1
owner_id
integer | null
permissions
PermissionsPayload · object
can_edit
boolean
default:false
scans
ScanListItem · object[]
valid_images
integer | null
invalid_images
integer | null
document_count
integer | null
class_count
integer | null
classes
string[]
image_specificity
enum<string>
default:fine
Available options:
fine,
broad
active_scan_progress
integer | null
active_scan_elapsed_seconds
number | null
active_scan_message
string | null
active_scan_started_at
string | null
active_scan_id
string | null
active_scan_status
string | null
active_scan_type
string | null
issue_type
string | null
webhook_url
string | null
repo_url
string | null
repo_requires_auth
boolean | null
has_repo_access_token
boolean
default:false
webhook_on_complete
boolean
default:false
webhook_on_failure
boolean
default:false
queued_scan_count
integer
default:0
issue_counts
DatasetIssueCounts · object
latest_mislabel_scan_id
string | null
processing
boolean
default:false
processed_3d
boolean | null
import_job_id
string | null
import_provider
string | null
import_status
string | null
import_progress
integer | null
import_message
string | null
import_error
string | null
import_cancel_requested
boolean
default:false
import_updated_at
string | null
import_has_stored_credentials
boolean
default:false
import_can_retry
boolean
default:false
dense_branch_build
Dense Branch Build · object