List PPS records

List filters are passed as query parameters — see the conventions in the introduction.

GET/pps

Authorization

AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Responses

200

OK.

Array of Pps

idstring

PPS ID (read-only)

appIdstring

Application ID (read-only)

namestring

PPS name (read-only)

customIdstring

Custom ID (read-only)

descriptionstring

PPS description

ppsSidstring

PPS SID (read-only)

createdAtstring

Creation date (ISO date, autoassigned, read-only)

401

Authentication failed. All causes return this identical response.

codeinteger

messagestring

typestring

default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger

messagestring

typestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Request

curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/pps' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://next.amfg.ai/engine-service/public-api/v1/pps", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://next.amfg.ai/engine-service/public-api/v1/pps",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

[
  {
    "id": "176",
    "appId": "1677",
    "name": "BEAD BLAST",
    "customId": "BB",
    "description": "Bead desc",
    "ppsSid": "X-100-PPS-95000",
    "createdAt": "2020-02-05T16:21:31.462Z"
  }
]

{
  "code": 401,
  "message": "Not Authorized"
}

{
  "code": 0,
  "message": "string",
  "type": "string"
}