List API Key Scopes

GET

api

auth

api-keys

scopes

List API Key Scopes

curl --request GET \
  --url https://api.example.com/api/v1/auth/api-keys/scopes

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/auth/api-keys/scopes', 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://api.example.com/api/v1/auth/api-keys/scopes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/auth/api-keys/scopes"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/auth/api-keys/scopes")

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

request = Net::HTTP::Get.new(url)

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

{
  "read": [
    "<string>"
  ],
  "node": [
    "<string>"
  ],
  "write": [
    "<string>"
  ],
  "danger": [
    "<string>"
  ],
  "default": [
    "<string>"
  ],
  "locked": [
    "<string>"
  ]
}

Returns the catalog of API key scopes, grouped the way the dashboard shows them. Use it to discover the valid scope names. Node API keys are a separate kind of key: they carry only the node_api scope, never together with the other scopes, and work only at node.tronrental.com. You create them as endpoints in Dashboard → Node API; how many you can have depends on your Node API plan. A Node API key cannot call this endpoint — the REST API answers it with 403 NODE_API_KEY_ONLY. See Node API → Endpoints and keys.

Response

string[]

Read scopes: view, deposit_view

string[]

The Node API scope: node_api. A key with it carries no other scope

string[]

Scopes that spend the balance or change services: buy_energy, buy_bandwidth, smart_mode, transfer_packages, energy_resale

string[]

withdraw. Enabling it on a key requires 2FA and a non-empty IP whitelist

string[]

Scopes a new REST API key gets when none are chosen: every read and write scope, without withdraw

string[]

Scopes every REST API key always has: view

Example

curl https://api.tronrental.com/v1/auth/api-keys/scopes \
  -H "X-API-Key: your_api_key"

Response

{
  "read": ["view", "deposit_view"],
  "node": ["node_api"],
  "write": ["buy_energy", "buy_bandwidth", "smart_mode", "transfer_packages", "energy_resale"],
  "danger": ["withdraw"],
  "default": ["view", "deposit_view", "buy_energy", "buy_bandwidth", "smart_mode", "transfer_packages", "energy_resale"],
  "locked": ["view"]
}

List API Key Scopes

curl --request GET \
  --url https://api.example.com/api/v1/auth/api-keys/scopes

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/auth/api-keys/scopes', 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://api.example.com/api/v1/auth/api-keys/scopes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/auth/api-keys/scopes"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/auth/api-keys/scopes")

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

request = Net::HTTP::Get.new(url)

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

{
  "read": [
    "<string>"
  ],
  "node": [
    "<string>"
  ],
  "write": [
    "<string>"
  ],
  "danger": [
    "<string>"
  ],
  "default": [
    "<string>"
  ],
  "locked": [
    "<string>"
  ]
}

Core API

Bandwidth Rentals

Auto Refill

Orders

Invoices

Smart Mode

Transfer Packages

Account

Webhooks

List API Key Scopes