Archive entity types

curl --request POST \
  --url https://api.stigg.io/api/v1-beta/entity-types/archive \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "ids": [
    "team"
  ]
}
'

import requests

url = "https://api.stigg.io/api/v1-beta/entity-types/archive"

payload = { "ids": ["team"] }
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ids: ['team']})
};

fetch('https://api.stigg.io/api/v1-beta/entity-types/archive', 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.stigg.io/api/v1-beta/entity-types/archive",
  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([
    'ids' => [
        'team'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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://api.stigg.io/api/v1-beta/entity-types/archive"

	payload := strings.NewReader("{\n  \"ids\": [\n    \"team\"\n  ]\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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://api.stigg.io/api/v1-beta/entity-types/archive")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    \"team\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.stigg.io/api/v1-beta/entity-types/archive")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    \"team\"\n  ]\n}"

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

{
  "data": {
    "ids": [
      "team"
    ]
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

POST

api

v1-beta

entity-types

archive

Archive entity types

curl --request POST \
  --url https://api.stigg.io/api/v1-beta/entity-types/archive \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "ids": [
    "team"
  ]
}
'

import requests

url = "https://api.stigg.io/api/v1-beta/entity-types/archive"

payload = { "ids": ["team"] }
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ids: ['team']})
};

fetch('https://api.stigg.io/api/v1-beta/entity-types/archive', 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.stigg.io/api/v1-beta/entity-types/archive",
  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([
    'ids' => [
        'team'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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://api.stigg.io/api/v1-beta/entity-types/archive"

	payload := strings.NewReader("{\n  \"ids\": [\n    \"team\"\n  ]\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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://api.stigg.io/api/v1-beta/entity-types/archive")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    \"team\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.stigg.io/api/v1-beta/entity-types/archive")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    \"team\"\n  ]\n}"

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

{
  "data": {
    "ids": [
      "team"
    ]
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

Authorizations

X-API-KEY

string

header

required

Server API Key

Headers

X-ACCOUNT-ID

string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID

string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

List of entity type identifiers to act on in bulk (1-100 entries)

ids

string[]

required

Entity type identifiers to act on

Required array length: 1 - 100 elements

The unique identifier for the entity type

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

Response

The entity type ids from the request.

Wrapped response echoing the entity type ids that were acted on by an archive call

data

EntityTypeIdsResponse · object

required

List of entity type identifiers that were acted on

Show child attributes