Returns the list of all APIs for a given account.

get https://api.{location}.console.panoptica.app/api/apisec/v2/trace-analysis/apis

This endpoint lists all the APIs discovered by Panoptica API Security, and shows several metadata about each API.

Query Params

textFilter

string

length ≤ 100

Show only results that contain the specified keywords.

apiType

string

Show only the specified type of APIs in the results: ThirdPartyApi, InternalApi, ExternallyExposedApi

securityContext

array of strings

length ≤ 20

The type of security issue found in the API.

securityContext

traceSourceType

array of strings

length ≤ 100

Show only results of the specified trace source types.

traceSourceType

severity

array of strings

length ≤ 100

Show only security findings of the specified severity level.

severity

offset

integer

≥ 0

Defaults to 0

Specifies the offset from which to show the result list.

max

integer

1 to 65000

Defaults to 100

The max number of results to show on a page.

sort

string

Defaults to HighestSeverity

Sort the results by the specified parameter. Only the HighestSeverity and UpdatedAt parameters can be used.

order

string

Defaults to desc

The order of the results.

Responses

Response body

object

items

array of objects

length ≤ 100

items

object

apiType

string

required

The type of the API: internal API, externally exposed API, or third-party API.

ThirdPartyApi InternalApi ExternallyExposedApi

createdAt

date-time

required

length ≤ 30

endpointCount

integer

required

0 to 65000

Defaults to 0

The number of endpoints discovered for this API. Use this property to find which API has the most endpoints.

externallyExposedApi

object

hasNewEndpoints

boolean

required

true if new endpoints have been recently discovered

highestSeverity

string

The severity of a finding, one of the following: Info, Low, Medium, High, Critical

Info Low Medium High Critical

hostname

string

required

length ≤ 255

The hostname where the API is available.

string

required

length ≤ 50

unique identifier of the API

isManuallyAdded

boolean

true if this API has been manually added

k8sServiceRef

object

For APIs that are hosted in Kubernetes, this parameter shows where the API is available, for example, on which cluster, in which namespace.

lastSeenAt

date-time

length ≤ 30

linkedInternalApis

array of objects

length ≤ 20

For externally exposed APIs, this field contains the IDs of internal APIs that are linked to this externally exposed API.

linkedInternalApis

object

hostname

string

required

length ≤ 255

API hostname

string

required

length ≤ 50

API identifier

port

integer

0 to 65535

port where the API is exposed

rootpath

string

length ≤ 300

API root path in the form /aaa/bbb/ccc

type

string

required

The type of the API: internal API, externally exposed API, or third-party API.

ThirdPartyApi InternalApi ExternallyExposedApi

url

string

required

length ≤ 300

Full API url

port

integer

required

0 to 65535

port where the API is exposed

rootpath

string

length ≤ 300

API root path in the form /aaa/bbb/ccc

securityContexts

array of strings

length ≤ 20

A list of auxiliary context information that help establish the security posture of the API.

securityContexts

securityFindings

object

required

The number of security findings that API Security has detected for the API. The findings are grouped into categories based on the severity of the finding. The total category shows the sum of the findings in all other categories.

specUploaded

boolean

required

thirdPartyApiScoringJobState

string

Scheduled Completed Failed

traceSourceRef

object

updatedAt

date-time

required

length ≤ 30

url

string

required

length ≤ 300

The URL for the API. The URL can be formed from other fields. It's precomputed for convenience: {hostname}[.{namespace}][:{port}]/{rootpath}

totalCount

integer

0 to 99999

total number of items before pagination

Headers

object

Date

string

The timestamp the response was processed, based on the server's clock, in RFC 5322 date and time format. GMT must be used as the time zone reference for this header.

Link

string

Pagination links for navigating between pages of results.

TrackingID

string

length ≤ 50

Unique identifier for the request

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.us1.console.panoptica.app/api/apisec/v2/trace-analysis/apis?offset=0&max=100&sort=HighestSeverity&order=desc' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK

400Bad Request

404Not Found

500Internal Server Error

defaultBad Request