create team role

Creates a new role within a team. Only team owners or managers with the appropriate permissions can perform this operation.

CLI Usage: vastai create team role --name <role_name> --permissions <permissions_json>

POST /api/v0/team/roles

create team role

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/team/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "developer",
  "permissions": {
    "api": {
      "user_read": {},
      "instance_write": {}
    }
  }
}
'

import requests

url = "https://console.vast.ai/api/v0/team/roles"

payload = {
    "name": "developer",
    "permissions": { "api": {
            "user_read": {},
            "instance_write": {}
        } }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'developer', permissions: {api: {user_read: {}, instance_write: {}}}})
};

fetch('https://console.vast.ai/api/v0/team/roles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://console.vast.ai/api/v0/team/roles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'developer',
    'permissions' => [
        'api' => [
                'user_read' => [
                                
                ],
                'instance_write' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://console.vast.ai/api/v0/team/roles"

	payload := strings.NewReader("{\n  \"name\": \"developer\",\n  \"permissions\": {\n    \"api\": {\n      \"user_read\": {},\n      \"instance_write\": {}\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://console.vast.ai/api/v0/team/roles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"developer\",\n  \"permissions\": {\n    \"api\": {\n      \"user_read\": {},\n      \"instance_write\": {}\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/team/roles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"developer\",\n  \"permissions\": {\n    \"api\": {\n      \"user_read\": {},\n      \"instance_write\": {}\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "msg": "success"
}

{
  "success": false,
  "msg": "Missing permissions parameter"
}

{
  "success": false,
  "error": "<string>",
  "msg": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "msg": "<string>"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

name · string · required

Name for the new role

Example:

"developer"

permissions · object · required

JSON object containing permission definitions

Show child attributes

Response

200

application/json

Role created successfully

msg · string

Example:

"success"