Set applied policy archived state
Archive or unarchive a specific policy applied to a project
put
https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/archivedbash
curl --request PUT \
--url 'https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/archived' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"archived":true}'javascript
const response = await fetch("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/archived", {
method: "PUT",
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"archived": true
})
});
const data = await response.json();typescript
interface AppliedPolicy {
appliedAt?: string;
appliedBy?: string;
appliedByDid?: string;
archivedAt?: string;
archivedBy?: string;
archivedByDid?: string;
cid?: string;
createdAt?: string;
id?: number;
isArchived?: boolean;
isReapplied?: boolean;
name?: string;
policyId?: number;
projectId?: number;
slug?: string;
status?: string;
subjectCid?: string;
updatedAt?: string;
}
const response = await fetch("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/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: AppliedPolicy = await response.json();python
import requests
response = requests.put(
"https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/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/projects/{projectId}/policies/{appliedPolicyId}/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/projects/{projectId}/policies/{appliedPolicyId}/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/projects/{projectId}/policies/{appliedPolicyId}/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/projects/{projectId}/policies/{appliedPolicyId}/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/projects/{projectId}/policies/{appliedPolicyId}/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/projects/{projectId}/policies/{appliedPolicyId}/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
| Name | Type | Description |
|---|---|---|
projectIdrequired | string | Project ID, UUID (urn:uuid optional), or slug:my-project |
appliedPolicyIdrequired | string | Applied policy ID, slug:my-policy, or urn:cid:bafy... |
Request bodyrequired
Archived state
application/json
archivedbooleanrequired
Examplejson
{
"archived": true
}Responses
200Updated applied policy
application/json
appliedAtstring<date-time>read-onlyappliedBystringread-onlyappliedByDidstringread-onlyVerifiable actor; appliedBy is the label
archivedAtstring<date-time>read-onlySet via the archive endpoint
archivedBystringread-onlySet via the archive endpoint
archivedByDidstringread-onlyVerifiable actor; archivedBy is the label
cidstringread-onlyAssigned by the Integrity Service
createdAtstring<date-time>read-onlyidintegerread-onlyisArchivedbooleanread-onlySet via the archive endpoint
isReappliedbooleanread-onlynamestringpolicyIdintegerread-onlyTaken from the path on create
projectIdintegerread-onlyTaken from the path on create
slugstringread-onlyDerived from name
statusstringread-onlysubjectCidstringread-onlyAssigned by the Integrity Service
updatedAtstring<date-time>read-only
Examplejson
{
"appliedAt": "2025-01-01T00:00:00Z",
"appliedBy": "string",
"appliedByDid": "string",
"archivedAt": "2025-01-01T00:00:00Z",
"archivedBy": "string",
"archivedByDid": "string",
"cid": "string",
"createdAt": "2025-01-01T00:00:00Z",
"id": 0,
"isArchived": true,
"isReapplied": true,
"name": "string",
"policyId": 0,
"projectId": 0,
"slug": "string",
"status": "string",
"subjectCid": "string",
"updatedAt": "2025-01-01T00:00:00Z"
}400Bad request - Invalid IDs or missing archived flag
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"
}404Applied policy not found
application/json
errorstring
Examplejson
{
"error": "Invalid request body"
}500Internal server error
application/json
errorstring
Examplejson
{
"error": "Invalid request body"
}