Skip to content
/
Update an app

Update an app

Request

Security
x-api-key
Path
idstringrequired

Unique identifier for the app

Bodyapplication/jsonrequired

Update an app's approval status, sensitivity level, and/or notes.

approvalStatusstring or null

The desired approval status for the app. If null, the current approval status will be unset.

Enum:"APPROVED""NOT_APPROVED""UNDER_REVIEW"
Example:"APPROVED"
sensitivityLevelstring or null

The desired sensitivity level for the app. If null, the current sensitivity level will be unset.

Enum:"HIGH""MEDIUM""LOW"
Example:"HIGH"
notesstring or null

The desired notes for the app. If null, any existing notes will be deleted.

Example:"Last security audit: 16 January 2024"
ownerIdstring or null

The employee ID for the owner of this app. If null, the current owner will be unset.

PATCH
/v1/apps/{id}
curl -i -X PATCH \
  'https://api.pushsecurity.com/v1/apps/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

OK

Headers
any
Bodyapplication/json
idstring

Unique identifier for this object

Example:"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"
typestring

The type of app, formatted as an ENUM value.

Example:"ZAPIER"
approvalStatusstring or null(ApprovalStatusType)

Approval status of the app, null if not set

Enum ValueDescription
UNDER_REVIEW

The app is under review

APPROVED

The app has been approved

NOT_APPROVED

The app has not been approved

sensitivityLevelstring or null(SensitivityLevelType)

The sensitivity level of the app, null if not set

Enum ValueDescription
HIGH

The sensitivity of the app is high

MEDIUM

The sensitivity of the app is medium

LOW

The sensitivity of the app is low

ownerIdstring or null

Identifier of the employee who is the owner of this platform

Example:"87569da6-fb7a-4df7-8ce2-246c14044911"
notesstring

Notes recorded on this app

Example:"Last security audit: 16 January 2023"
websitestring

URL to the app's homepage

Example:"https://zapier.com/"
descriptionstring

Description of the app's purpose

Example:"Zapier is a cloud-based automation tool that enables users to integrate and automate various web applications without requiring extensive coding know
friendlyNamestring

The friendly name of the app

Example:"Zapier"
labelsArray of strings

Labels associated with this app

Example:
[
  "GenAI",
  "marketing"
]
categoriesArray of objects(AppCategory)

Categories associated with this app

creationTimestampinteger

When the app was first observed, formatted as a UNIX timestamp (in seconds)

Example:1698064423
Response
{
  "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
  "type": "ZAPIER",
  "approvalStatus": "UNDER_REVIEW",
  "sensitivityLevel": "HIGH",
  "ownerId": "87569da6-fb7a-4df7-8ce2-246c14044911",
  "notes": "Last security audit: 16 January 2023",
  "website": "https://zapier.com/",
  "description": "Zapier is a cloud-based automation tool that enables users to integrate and automate various web applications without requiring extensive coding knowledge, potentially streamlining workflows and processes.",
  "friendlyName": "Zapier",
  "labels": [
    "GenAI",
    "marketing"
  ],
  "categories": [
    {
      "code": 83,
      "name": "AI/ML Applications",
      "group": "Technology"
    }
  ],
  "creationTimestamp": 1698064423
}