Skip to content

Bulk-upsert device roles (admin)

POST
/api/admin/seed/device-roles
 
curl --request POST \
  --url http://localhost:3000/api/admin/seed/device-roles \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{ "items": [ { "name": "example", "slug": "example", "color": "example", "description": "example", "tier": "example", "redundancy": "example", "complianceBaselines": [ "example" ], "vmRole": true, "typicalLocation": "example", "responsibilities": "example", "popular": true } ] }'

Upsert device roles keyed on slug.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
items
required
Array<object>
object
name
required
string
slug
string
color
string
description
string
nullable
tier
string
nullable
redundancy
string
nullable
complianceBaselines
Array<string>
vmRole
boolean
typicalLocation
string
nullable
responsibilities
string
nullable
popular
boolean
Example generated
{
  "items": [
    {
      "name": "example",
      "slug": "example",
      "color": "example",
      "description": "example",
      "tier": "example",
      "redundancy": "example",
      "complianceBaselines": [
        "example"
      ],
      "vmRole": true,
      "typicalLocation": "example",
      "responsibilities": "example",
      "popular": true
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Seed report

Media type application/json
object
data
object
created
required
integer
updated
required
integer
skipped
required
integer
errors
required
Array<object>
object
index
required
integer
key
string
nullable
message
required
string
Example generated
{
  "data": {
    "created": 1,
    "updated": 1,
    "skipped": 1,
    "errors": [
      {
        "index": 1,
        "key": "example",
        "message": "example"
      }
    ]
  }
}

400

Section titled “400 ”

Body must include items array

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

403

Section titled “403 ”

Admin access required

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}