Skip to main content
POST
/
v1
/
fips
Generate FIPS cryptographic assessment from ZIP bundle
curl --request POST \
  --url https://api.usenabla.com/v1/fips \
  --header 'Content-Type: application/json' \
  --header 'X-Customer-Key: <api-key>' \
  --data '
{
  "name": "production-crypto-audit",
  "format": "json",
  "zip_content": "UEsDBBQAAAAIAA=="
}
'
import requests

url = "https://api.usenabla.com/v1/fips"

payload = {
"name": "production-crypto-audit",
"format": "json",
"zip_content": "UEsDBBQAAAAIAA=="
}
headers = {
"X-Customer-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-Customer-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'production-crypto-audit',
format: 'json',
zip_content: 'UEsDBBQAAAAIAA=='
})
};

fetch('https://api.usenabla.com/v1/fips', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.usenabla.com/v1/fips",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'production-crypto-audit',
'format' => 'json',
'zip_content' => 'UEsDBBQAAAAIAA=='
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Customer-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.usenabla.com/v1/fips"

payload := strings.NewReader("{\n \"name\": \"production-crypto-audit\",\n \"format\": \"json\",\n \"zip_content\": \"UEsDBBQAAAAIAA==\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-Customer-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.usenabla.com/v1/fips")
.header("X-Customer-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"production-crypto-audit\",\n \"format\": \"json\",\n \"zip_content\": \"UEsDBBQAAAAIAA==\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.usenabla.com/v1/fips")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Customer-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"production-crypto-audit\",\n \"format\": \"json\",\n \"zip_content\": \"UEsDBBQAAAAIAA==\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "assessment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "framework": "NIST 800-53",
    "version": "Rev. 5",
    "timestamp": "2023-11-07T05:31:56Z",
    "controls": [
      {
        "control_id": "SC-13",
        "title": "Cryptographic Protection",
        "findings": [
          "<string>"
        ],
        "evidence": [
          "<string>"
        ]
      }
    ],
    "summary": {
      "total_controls": 123,
      "satisfied": 123,
      "not_satisfied": 123,
      "not_applicable": 123
    }
  },
  "artifacts": [
    {
      "filename": "nist80053-assessment.json",
      "content_type": "application/json",
      "content_base64": "<string>",
      "size_bytes": 123,
      "diagram": "<string>"
    }
  ]
}
{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>"
}
{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>"
}
{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>"
}

Authorizations

X-Customer-Key
string
header
required

Customer API key for authentication

Body

application/json
name
string
required

Name for the FIPS assessment

Example:

"production-crypto-audit"

format
enum<string>
required

Output format for the assessment

Available options:
oscal,
yaml,
json
Example:

"json"

zip_content
string
required

Base64-encoded ZIP archive. Supported file types: sbom.json/spdx.json (SBOM), *.tfstate (Terraform), *.yaml/manifest.yaml (Kubernetes), playbook.yaml (Ansible), package-lock.json/Cargo.lock/go.mod/poetry.lock (package managers), system_info.json/openssl.json (system crypto info)

Example:

"UEsDBBQAAAAIAA=="

Response

Evidence assessment completed successfully

id
string<uuid>
required

Unique identifier for this assessment

status
enum<string>
required

Assessment status

Available options:
completed,
failed
created_at
string<date-time>
required

Timestamp when assessment was created

assessment
object
required
artifacts
object[]
required

Generated artifacts (assessment files, diagrams)