Skip to content

Get Application

Retrieve a specific application by ID.

Endpoint

GET /api/apps/:id

Retrieves a single application with its complete configuration including URL filters and associated rules.

Authentication

Requires any valid API Key. All keys have read access.

Path Parameters

Parameter Type Description
id UUID Application ID

Response

Returns the complete application object:

Response Format 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Payment APIs",
  "description": "All payment processing endpoints",
  "urlFilters": [
    {
      "filterType": 1,
      "isWhitelist": false,
      "contentType": ["application/json"],
      "methods": ["POST", "PUT"],
      "filter": "payment.api.company.com",
      "comment": "Payment API hostname",
      "runContentTypeDetection": true
    }
  ],
  "rules": [
    {
      "id": "rule-uuid",
      "name": "Detect PII in Payments"
    }
  ],
  "createdAt": 1704067200,
  "updatedAt": 1704153600,
  "readOnly": false
}

Response Fields

Field Type Description
id UUID Unique application identifier
name string Application name
description string Application description
urlFilters array Array of URL filter configurations
rules array Rules that reference this application
createdAt integer Unix timestamp when created
updatedAt integer Unix timestamp of last update
readOnly boolean Whether this is a system application (cannot be modified)

Examples

Get Application by ID

Retrieve a specific application to view its configuration.

APP_ID="550e8400-e29b-41d4-a716-446655440000"

curl -X GET "https://your-shield-host:8080/api/apps/$APP_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

BASE_URL = "https://your-shield-host:8080"
HEADERS = {"Authorization": "Bearer YOUR_API_KEY"}

app_id = "550e8400-e29b-41d4-a716-446655440000"

response = requests.get(f"{BASE_URL}/api/apps/{app_id}", headers=HEADERS)
app = response.json()

print(f"Application: {app['name']}")
print(f"Filters: {len(app['urlFilters'])}")
print(f"Rules: {len(app['rules'])}")

const axios = require('axios');

const BASE_URL = 'https://your-shield-host:8080';
const HEADERS = { 'Authorization': 'Bearer YOUR_API_KEY' };

const appId = '550e8400-e29b-41d4-a716-446655440000';

const response = await axios.get(`${BASE_URL}/api/apps/${appId}`, { headers: HEADERS });
const app = response.data;

console.log(`Application: ${app.name}`);
console.log(`Filters: ${app.urlFilters.length}`);
console.log(`Rules: ${app.rules.length}`);

Error Responses

Status Code Description
401 Invalid or expired API key
404 Application not found