---
updatedAt: 2026-05-12T09:57:19.000Z
---

# Retrieve API asset information

This operation returns an object containing information about an API Asset, specified by the Site ID.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "APIAsset": {
        "description": "APIAsset provides the API data",
        "properties": {
          "abbreviation": {
            "type": "string"
          },
          "applianceID": {
            "format": "int64",
            "type": "integer"
          },
          "authentication": {
            "$ref": "#/components/schemas/AuthenticationInput"
          },
          "clientID": {
            "format": "int64",
            "type": "integer"
          },
          "customHeaders": {
            "items": {
              "$ref": "#/components/schemas/Header"
            },
            "type": "array"
          },
          "description": {
            "type": "string"
          },
          "hostname": {
            "type": "string"
          },
          "id": {
            "format": "int64",
            "type": "integer"
          },
          "industry": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization": {
            "type": "string"
          },
          "speed": {
            "format": "double",
            "type": "number"
          },
          "usesSatellite": {
            "type": "boolean"
          },
          "weight": {
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "AuthenticationInput": {
        "description": "AuthenticationInput is the structure of data received to update the login handler",
        "properties": {
          "oAuth": {
            "$ref": "#/components/schemas/OpenAuthentication"
          },
          "static": {
            "$ref": "#/components/schemas/StaticAuthentication"
          },
          "type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "Header": {
        "description": "Header is the structure of data received to update custom headers",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "OpenAuthentication": {
        "description": "OpenAuthentication is the structure of data used for OAuth",
        "properties": {
          "checkRequest": {
            "type": "string"
          },
          "clientID": {
            "type": "string"
          },
          "clientSecret": {
            "type": "string"
          },
          "definition": {
            "type": "string"
          },
          "format": {
            "type": "string"
          },
          "hostResolutionType": {
            "type": "string"
          },
          "password": {
            "type": "string"
          },
          "scope": {
            "type": "string"
          },
          "serverIPAddress": {
            "type": "string"
          },
          "serverType": {
            "type": "string"
          },
          "serviceProvider": {
            "type": "string"
          },
          "targetURL": {
            "type": "string"
          },
          "tokenOptions": {
            "type": "string"
          },
          "username": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "StaticAuthentication": {
        "description": "StaticAuthentication is the structure of data required to create a static api key login handler",
        "properties": {
          "location": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2023 WhiteHat Security"
    },
    "title": "Api Assets API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/apiAssets/{siteID}": {
      "get": {
        "description": "This operation returns an object containing information about an API Asset, specified by the Site ID.",
        "operationId": "getAPIAssetsReq",
        "parameters": [
          {
            "description": "Fields allows the user to specify optional fields returned in the get api response. Valid values are [authentication,customHeaders]",
            "explode": false,
            "in": "query",
            "name": "fields",
            "schema": {
              "items": {
                "type": "string"
              },
              "type": "array",
              "x-go-name": "Fields"
            },
            "style": "form"
          },
          {
            "description": "SiteID specifies which API asset's information will be retrieved",
            "in": "path",
            "name": "siteID",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer",
              "x-go-name": "SiteID"
            },
            "x-go-name": "SiteID"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/APIAsset"
                }
              }
            },
            "description": "APIResponse provides information about an API Asset"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            },
            "description": "BadRequestResponse indicates a request with invalid parameters"
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access"
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized"
          },
          "404": {
            "description": "NotFoundResponse indicates a request for a resource that does not exist"
          },
          "500": {
            "description": "GenericError generic error"
          }
        },
        "summary": "Retrieve API asset information",
        "tags": [
          "API Assets API v2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "API Assets API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```