Skip to content

http-api-check.md

Latest commit

 

History

History
75 lines (54 loc) · 2.78 KB

http-api-check.md

File metadata and controls

75 lines (54 loc) · 2.78 KB

← Quick Start

Quick Start: HTTP API Check

Get a working custom platform that validates connectivity to a REST API over HTTP in under 5 minutes.

What You'll Get

A minimal platform script that sends an HTTP request to an API endpoint to verify that the system is reachable and credentials are valid.

Steps

1. Copy the Minimal Template

Download or copy TemplateHttpMinimal.json and rename it (e.g., MyApiCheck.json).

2. Customize the Endpoint

Open the file and update the CheckSystem operation to hit your API's health or authentication endpoint. For example, if your API uses Basic Auth:

"CheckSystem": {
  "Parameters": [
    { "Address": { "Type": "String", "Required": true } },
    { "FuncUserName": { "Type": "String", "Required": true } },
    { "FuncPassword": { "Type": "Secret", "Required": true } }
  ],
  "Do": [
    { "BaseAddress": { "Address": "https://%Address%" } },
    { "NewHttpRequest": { "ObjectName": "HealthReq" } },
    { "HttpAuth": { "RequestObjectName": "HealthReq", "Type": "Basic", "Credentials": { "Login": "%FuncUserName%", "Password": "%FuncPassword%" } } },
    { "Request": { "RequestObjectName": "HealthReq", "ResponseObjectName": "HealthResp", "Verb": "GET", "Url": "/api/v1/health" } },
    {
      "Condition": {
        "If": "HealthResp.StatusCode != 200",
        "Then": { "Do": [{ "Throw": { "Value": "System check failed: HTTP %{HealthResp.StatusCode}%" } }] }
      }
    },
    { "Return": { "Value": true } }
  ]
}

Replace /api/v1/health with your target's actual endpoint. If the request succeeds (HTTP 200), the script returns true. Without an explicit Return, SPP treats the result as a failed check even when the API responds successfully.

3. Upload to SPP

# Create a new custom platform with the script
New-SafeguardCustomPlatform -Name "MyApiCheck" -ScriptFile .\MyApiCheck.json

# To update an existing platform's script later:
# Import-SafeguardCustomPlatformScript -PlatformToEdit "MyApiCheck" -ScriptFile .\MyApiCheck.json

4. Create an Asset

  1. In the SPP web UI, go to Asset Management > Assets > Add
  2. Set the platform to your new custom platform
  3. Set the network address to the API hostname
  4. Assign a service account with API credentials (username/password or token)

5. Test

Test-SafeguardAsset -AssetToTest "MyApiServer" -ExtendedLogging

If it reports success, SPP can reach your API.

Next Steps