EQTY LabDocs

Get applied policy control

Retrieve a control from an applied policy by applied policy control ID

gethttps://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}
bash
curl --request GET \
  --url 'https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
interface AppliedPolicyControlResponse {
  appliedPolicyId?: number;
  cid?: string;
  controlId?: number;
  createdAt?: string;
  id?: number;
  indicators?: Record<string, unknown>[];
  status?: string;
  updatedAt?: string;
}

const response = await fetch("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

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

response = requests.get(
    "https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")

	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}/controls/{appliedPolicyControlId}"))
            .header("Authorization", "Bearer <token>")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .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 var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

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}/controls/{appliedPolicyControlId}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
    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}/controls/{appliedPolicyControlId}")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

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, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://localhost:10001/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}")
        .header("Authorization", "Bearer <token>")
        .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
projectId
required
string

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

appliedPolicyId
required
string

Applied policy ID, slug:my-policy, or urn:cid:bafy...

appliedPolicyControlId
required
string

Applied policy control ID, code:AC-1, or urn:cid:bafy...

Responses

200Applied policy control

application/json
  • appliedPolicyIdinteger
  • cidstring
  • controlIdinteger
  • createdAtstring<date-time>
  • idinteger
  • indicatorscore.IndicatorApplication[]
    Show properties

    Array of core.IndicatorApplication

    • applicationUuidstring

      urn:uuid form

    • appliedPolicyControlIdinteger
    • createdAtstring<date-time>
    • criteriaobject

      Custom indicators only

    • declarationProfilecore.DeclarationProfile
      Show core.DeclarationProfile
      • emitOnobjectrequired

        When to emit a declaration

        Show properties

        object — When to emit a declaration

      • statementTemplatestring
      • titleTemplatestring
    • extractionRulesobject

      Custom indicators only

    • idinteger
    • indicatorIdstring

      urn:uuid form

    • lastEvaluatedAtstring<date-time>
    • parametersobject
    • statuscore.ApplicationStatus

      One ofactivedisabledarchived

    • triggerTypecore.TriggerType

      One ofevent

    • updatedAtstring<date-time>
  • statusstring
  • updatedAtstring<date-time>
Examplejson
{
  "appliedPolicyId": 0,
  "cid": "string",
  "controlId": 0,
  "createdAt": "2025-01-01T00:00:00Z",
  "id": 0,
  "indicators": [
    {
      "applicationUuid": "string",
      "appliedPolicyControlId": 0,
      "createdAt": "2025-01-01T00:00:00Z",
      "criteria": {},
      "declarationProfile": {
        "emitOn": {},
        "statementTemplate": "string",
        "titleTemplate": "string"
      },
      "extractionRules": {},
      "id": 0,
      "indicatorId": "string",
      "lastEvaluatedAt": "2025-01-01T00:00:00Z",
      "parameters": {},
      "status": "active",
      "triggerType": "event",
      "updatedAt": "2025-01-01T00:00:00Z"
    }
  ],
  "status": "string",
  "updatedAt": "2025-01-01T00:00:00Z"
}

400Bad request - Invalid project ID, applied policy ID, or control ID

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 control not found

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

500Internal server error

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