get entity by id - Hacken

get entity by id

curl --request GET \
  --url https://api.example.com/api/v1/plan/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/plan/{id}', 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/plan/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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/plan/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/plan/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": 1,
  "createdAt": 123,
  "updatedAt": 123,
  "status": "ACTIVE",
  "name": "<string>",
  "maxUsers": 123,
  "maxContracts": 123,
  "maxProjects": 123,
  "maxTriggers": 123,
  "maxDetectors": 123,
  "maxWallets": 123,
  "maxActions": 123,
  "maxApiKeys": 123,
  "detectorRateLimit": 123,
  "detectorRateLimitDuration": 123
}

GET

/

api

/

v1

/

plan

/

{id}

get entity by id

curl --request GET \
  --url https://api.example.com/api/v1/plan/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/plan/{id}', 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/plan/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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/plan/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/plan/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": 1,
  "createdAt": 123,
  "updatedAt": 123,
  "status": "ACTIVE",
  "name": "<string>",
  "maxUsers": 123,
  "maxContracts": 123,
  "maxProjects": 123,
  "maxTriggers": 123,
  "maxDetectors": 123,
  "maxWallets": 123,
  "maxActions": 123,
  "maxApiKeys": 123,
  "detectorRateLimit": 123,
  "detectorRateLimitDuration": 123
}

Authorizations

Authorization

string

header

required

Authentication

Path Parameters

id

integer<int64>

required

Response

200 - application/json

OK

id

integer<int64>

Unique identifier of the entity

Example:

1

createdAt

integer<int64>

Time when entity was created

updatedAt

integer<int64>

Time when entity was updated

status

enum<string>

Status of the entity. Default: 'ACTIVE'

Available options:

ACTIVE,

DISABLED,

DELETED

name

string

Name for the entity

maxUsers

integer<int32>

The maximum number of users allowed under this plan

maxContracts

integer<int32>

The maximum number of contracts allowed under this plan

maxProjects

integer<int32>

The maximum number of projects allowed under this plan

maxTriggers

integer<int32>

The maximum number of triggers allowed under this plan

maxDetectors

integer<int32>

The maximum number of detectors allowed under this plan

maxWallets

integer<int32>

The maximum number of wallets allowed under this plan

maxActions

integer<int32>

The maximum number of actions allowed under this plan

maxApiKeys

integer<int32>

The maximum number of api keys allowed under this plan

detectorRateLimit

integer<int32>

The maximum rate of detector alerts per duration

detectorRateLimitDuration

integer<int32>

The time duration (in milliseconds) per which the maximum rate of detector alerts is allowed