EQTY LabDocs

Set project archived state

Archive or unarchive a specific project; archiving requires all applied policies to be archived first

puthttps://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived
bash
curl --request PUT \
  --url 'https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"archived":true}'
javascript
const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "archived": true
  })
});

const data = await response.json();
typescript
interface Project {
  archivedAt?: string;
  createdAt?: string;
  description?: string;
  id?: number;
  isArchived?: boolean;
  name?: string;
  organizationId?: number;
  slug?: string;
  updatedAt?: string;
  uuid?: string;
}

const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "archived": true
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: Project = await response.json();
python
import requests

response = requests.put(
    "https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "archived": True,
    },
)
response.raise_for_status()
print(response.json())
go
package main

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

func main() {
	body := strings.NewReader(`{
	  "archived": true
	}`)
	req, err := http.NewRequest(http.MethodPut, "https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived"))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString("""
                {
                  "archived": true
                }
                """))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "archived": true
    }
    """, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "archived": true
    }
    JSON,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "archived": true
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .put("https://localhost:10001/api/v1/organizations/{orgId}/projects/{projectId}/archived")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "archived": true
        }))
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.

Parameters

Path parameters

NameTypeDescription
orgId
required
string

Organization ID or UUID (urn:uuid optional)

projectId
required
string

Project ID, UUID (urn:uuid optional), or slug:my-project

Request bodyrequired

Archived state

application/json
  • archivedbooleanrequired
Examplejson
{
  "archived": true
}

Responses

200Updated project

application/json
  • archivedAtstring<date-time>read-only

    Set via the archive endpoint

  • createdAtstring<date-time>read-only
  • descriptionstring
  • idintegerread-only
  • isArchivedbooleanread-only

    Set via the archive endpoint

  • namestring
  • organizationIdintegerread-only

    Taken from the path on create

  • slugstringread-only

    Derived from name

  • updatedAtstring<date-time>read-only
  • uuidstringread-only

    urn:uuid form

Examplejson
{
  "archivedAt": "2025-01-01T00:00:00Z",
  "createdAt": "2025-01-01T00:00:00Z",
  "description": "string",
  "id": 0,
  "isArchived": true,
  "name": "string",
  "organizationId": 0,
  "slug": "string",
  "updatedAt": "2025-01-01T00:00:00Z",
  "uuid": "string"
}

400Bad request - Invalid project ID, missing archived flag, or active policies remain

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

401Unauthorized - Authentication required

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

403Forbidden - No project access or insufficient permissions

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

404Project not found

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

500Internal server error

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}