How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vectra AI Assignments API

Dedicated endpoint to Assignments.

Vectra AI Assignments API is one of 17 APIs that Vectra AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Assignments. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 8 operations across 4 paths, and defines 22 schemas. It is described by OpenAPI 3.0.2, at version 1.0.0.

Requests are made against a single base URL, https://{fqdn}/api/{apiVersion}.

8 operations 4 paths 22 schemas 1 DELETE3 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0.0
Base URL
https://platform.vectra.ai/api/v3.3
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Vectra AI Assignments API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (VectraToken). By default, every request must be authenticated.

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Assignments 8

Dedicated endpoint to Assignments.

GET
/assignments
Get all assignments
assignmentGetSeveral 6 params → 200401403
POST
/assignments
Used to assign an entity to a user
assignmentAssign body → 201400401403409
GET
/assignment/{assignmentID}
Describe a specific assignment
assignmentGetSingle 1 param → 200401403404
PUT
/assignment/{assignmentID}
Reassign an assignment
assignmentUpdate 1 param body → 200401403
DELETE
/assignment/{assignmentID}
Delete an assignment
assignmentDelete 1 param → 204401403
PUT
/assignment/{assignmentID}/resolve
Resolve an assignment
assignmentResolve 1 param body → 200401403409
GET
/assignments/{assignment_id}
Retrieve specific assignment details
getAssignmentById 1 param → 200
PATCH
/assignments/{assignment_id}
Resolve an assignment
resolveAssignment 1 param body → 204

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are assignment (11 properties), Assignment (6 properties), assignmentOutcome (5 properties), assignmentResolveRequestBody (5 properties). Each schema is shown below with its type and property counts.

Assignment
object
6 properties
assignmentOutcome
object
Label resolution outcome for an assignment
5 properties 5 required
assignmentHistorycalEvent
object
Assignment history event
5 properties
assignmentUser
object
Assignment user (tiny Vectra User)
2 properties
link
string
URL Link
positiveInt
integer
assignmentUpdateRequestBody
object
1 property 1 required
resultsOfAssignments
isoDate
string
ISO representation of a date
name
string
assignment
object
Assignment
11 properties 4 required
assignmentAccountRequestBody
object
2 properties 2 required
arrayOfIDs
array
Array of IDs
text
string
assignmentResolveRequestBody
object
5 properties 1 required
error
object
2 properties
ID
integer
ID
vectraScore
number
results
object
3 properties
assignmentEventType
string
Type of event that can happen to an assignment
assignmentHostRequestBody
object
2 properties 2 required
assignmentOutcomeCategory
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vectranetworks-assignments-api-openapi.yml Raw ↑

Other APIs Vectra AI publishes across the network.

Vectra AI Accounts API
Vectra AI Assignment Outcomes API
Vectra AI Detections API
Vectra AI Entities API
Vectra AI Events API
Vectra AI Groups API
Vectra AI Health API
Vectra AI Hosts API
Vectra AI Lockdown API
Vectra AI Match API
Vectra AI Notes API
Vectra AI Proxies API
Where this information came from

This is an independent, third-party profile of Vectra AI Assignments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.