app

delete-forge-app-property

Deletes a Forge app property.

Deletes a Forge app property. This API can only be accessed using asApp() requests from Forge.

DELETE /app/properties/{propertyKey}

Flag	Type	Required	Description
--propertyKey	string	Yes	The key of the property

Example:

cf app delete-forge-app-property --propertyKey <propertyKey>

get-forge-app-properties

Get Forge app properties.

Gets Forge app properties. This API can only be accessed using asApp() requests from Forge.

GET /app/properties

Flag	Type	Required	Description
--cursor	string	No	Used for pagination, this opaque cursor represents the last returned property key. It will be included in the response body as the next link. Use this key to request the next set of results.
--limit	string	No	Maximum number of app properties per result to return. If more results exist, use the last returned property key from the Link field in the response body as a cursor to retrieve the next set of results.

Example:

cf app get-forge-app-properties

get-forge-app-property

Get a Forge app property by key.

Gets a Forge app property by property key. This API can only be accessed using asApp() requests from Forge.

GET /app/properties/{propertyKey}

Flag	Type	Required	Description
--propertyKey	string	Yes	The key of the property

Example:

cf app get-forge-app-property --propertyKey <propertyKey>

put-forge-app-property

Create or update a Forge app property.

Creates or updates a Forge app property. This API can only be accessed using asApp() requests from Forge.

PUT /app/properties/{propertyKey}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--propertyKey	string	Yes	The key of the property

Example:

cf app put-forge-app-property --propertyKey <propertyKey>