Prismatic CLI Command Reference

The Prismatic CLI tool allows you to interact with the Prismatic API programmatically so you can build, deploy, and support integrations from the command line. This page lists the subcommands of prism that you can invoke. For an introduction on using the Prismatic CLI tool, see the CLI usage page.


Alerts CLI Commands

alerts:events:list

List Alert Events for an Alert Monitor

prism alerts:events:list --alertMonitorId <string> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--alertMonitorId-mID of an alert monitortrue
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

alerts:groups:create

Create an Alert Group

prism alerts:groups:create --name <string> [--users <string>] [--webhooks <string>]
FlagShorthandDescriptionRequired
--name-nname of the group to be createdtrue
--users-uJSON-formatted list of Prismatic user IDs to alertfalse
--webhooks-wJSON-formatted list of Alert Webhook IDs to alertfalse
# Create an group for "DevOps"
prism alerts:groups:create \
--name DevOps \
--users "[\"$(prism organization:users:list \
--columns id \
--filter 'Name=John Doe' \
--no-header)\"]"

alerts:groups:delete

Delete an Alert Group

prism alerts:groups:delete <group>
FlagShorthandDescriptionRequired
groupID of the group to deletetrue

alerts:groups:list

List Alert Groups in your Organization

prism alerts:groups:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false
# Fetch the ID and Name of all alert groups in JSON format, sorted descending by name
prism alerts:groups:list --columns id,name --output json --sort -name

alerts:monitors:clear

Clear an Alert Monitor

prism alerts:monitors:clear <monitor>
FlagShorthandDescriptionRequired
monitorID of the monitor to cleartrue

alerts:monitors:create

Create an Alert Monitor by attaching an Alert Trigger and a set of users and webhooks to an Instance

prism alerts:monitors:create --name <string> --instance <string> --triggers <string> [--duration <string>] [--log-severity <string>] [--groups <string>] [--users <string>]
FlagShorthandDescriptionRequired
--duration-dgreatest time allowed (in seconds) for time-based triggersfalse
--groups-gJSON-formatted list of group IDs to alertfalse
--instance-iID of the instance to monitortrue
--log-severity-sgreatest log level {info, log, warn, error, fatal} allowed for log-based triggersfalse
--name-nname of the alert monitor to be createdtrue
--triggers-tJSON-formatted list of trigger IDs that should trigger this monitortrue
--users-uJSON-formatted list of Prismatic user IDs alertfalse
Alert Monitors and Alert Groups

While individual users and webhooks can be tied to alert monitors, it is recommended that you create alert groups and attach alert groups to alert monitors. This helps in the case that you need to add a user to a set of monitors: it's simpler to edit a single alert group than to edit dozens of alert monitors.

# Create an alert monitor for an instance named "My Instance"
# and alert the "DevOps" group in the event that an
# instance execution takes longer than 10 seconds.
prism alerts:monitors:create \
--name "Alert Devops of slow execution" \
--instance $(prism instances:list \
--columns id \
--filter 'name=My Instance' \
--no-header)
--triggers "[\"$(prism alerts:triggers:list \
--columns id \
--filter 'name=Execution Duration Matched or Exceeded' \
--no-header)\"]" \
--duration 10
--groups "[\"$(prism alerts:groups:list \
--columns id \
--filter 'name=DevOps' \
--no-header)\"]" \

alerts:monitors:delete

Delete an Alert Monitor

prism alerts:monitors:delete <monitor>
FlagShorthandDescriptionRequired
monitorID of the monitor to deletetrue

alerts:monitors:list

List Alert Monitors for Customer Instances

prism alerts:monitors:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

alerts:triggers:list

List Alert Triggers

prism alerts:triggers:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

alerts:webhooks:create

Create an Alert Webhook

prism alerts:webhooks:create --name <string> --url <string> [--headers <string>] --payloadTemplate <string>
FlagShorthandDescriptionRequired
--headers-hJSON-formatted object of key/value pairs to include in the request headerfalse
--name-nname of the webhook to be createdtrue
--payloadTemplate-ptemplate string that will be used as the request body, see documentation for detailstrue
--url-uURL that will receive a POST request for an alerttrue

alerts:webhooks:delete

Delete an Alert Webhook

prism alerts:webhooks:delete <webhook>
FlagShorthandDescriptionRequired
webhookID of the webhook to deletetrue

alerts:webhooks:list

List Alert Webhooks

prism alerts:webhooks:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

Authorization-methods CLI Commands

authorization-methods:list

List Authorization Methods that Components can use

prism authorization-methods:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

Billing CLI Commands

billing:invoices:list

List Invoices

prism billing:invoices:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

billing:plans:list

List Plans

prism billing:plans:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

Components CLI Commands

components:actions:list

List Actions that Components implement

prism components:actions:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false
# Get the ID of the GET action of the HTTP component by action key
prism components:actions:list --columns id --filter 'key=httpGet' --no-header
# Get actions related to the SFTP component
prism components:actions:list --filter 'componentkey=sftp'

components:delete

Delete a Component

prism components:delete <component>
FlagShorthandDescriptionRequired
componentID of the component to deletetrue

components:init

Initialize a new Component

prism components:init <name>
FlagShorthandDescriptionRequired
nameName of the new component to createtrue
# Initialize a new component directory for a component named "externalVendor"
prism components:init externalVendor

components:list

List available Components

prism components:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

components:publish

Publish a Component to Prismatic

prism components:publish [--confirm] [--skip-upload] [--skip-on-signature-match]
FlagShorthandDescriptionRequired
--confirmInteractively confirm publishfalse
--skip-on-signature-matchSkips component publish if the new signature matches the existing signaturefalse
--skip-uploadSkip upload of Component packagefalse
Building Components

See writing custom components for information on building components with webpack.

# Build and publish a component
npx webpack
cd dist/
prism components:publish

Customers CLI Commands

customers:config-vars:create

Create a Customer-specific Config Variable

prism customers:config-vars:create --customer <string> --key <string> --value <string>
FlagShorthandDescriptionRequired
--customer-cID of the customertrue
--key-kkey used to identify a config variabletrue
--value-vvalue of the config variabletrue

customers:config-vars:delete

Delete a Customer Config Variable

prism customers:config-vars:delete <config-variable>
FlagShorthandDescriptionRequired
config-variableID of the config variable to deletetrue

customers:config-vars:list

List Config Variables for a Customer

prism customers:config-vars:list --customer <string> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--customer-cID of a customertrue
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

customers:create

Create a new Customer

prism customers:create --name <string> [--description <string>]
FlagShorthandDescriptionRequired
--description-dlonger description of the customerfalse
--name-nshort name of the new customertrue

customers:credentials:create

Create a set of Customer-specific Credentials for use by Instance Actions

prism customers:credentials:create --customer <string> --label <string> --authorization-method <string> [--fields <string>]
FlagShorthandDescriptionRequired
--authorization-method-aID of the authorization methodtrue
--customer-cID of the customertrue
--fields-fusername, password, etc., in JSON formatfalse
--label-lname to give the new credentialstrue
# Save a JWT token for "Our First Customer"
prism organization:credentials:create \
--label 'JWT to website.com' \
--authorization-method api_key \
--fields '{"api_key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiUHJpc21hdGljIiwiaXNCZXN0Ijp0cnVlfQ.vZVPo0uF4OBlZWKTuXipCDS4tsfq74aQTs3wRROqM_M"}' \
--customer $(prism customers:list \
--columns=id \
--filter 'name=Our First Customer' \
--no-header)

customers:credentials:delete

Delete a Customer Credential

prism customers:credentials:delete <credential>
FlagShorthandDescriptionRequired
credentialID of the credential to deletetrue

customers:credentials:list

List Credentials for a Customer

prism customers:credentials:list --customer <string> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--customer-cID of a customertrue
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

customers:delete

Delete a Customer

prism customers:delete <customer>
FlagShorthandDescriptionRequired
customerID of the customer to deletetrue

customers:list

List your Customers

prism customers:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

customers:update

Update a Customer

prism customers:update <customer> [--name <string>] [--config-vars <string>]
FlagShorthandDescriptionRequired
customerID of a customertrue
--config-vars-vJSON-formatted config variablesfalse
--name-nname of the customerfalse

customers:users:create

Create a User for the specified Customer

prism customers:users:create --email <string> --role <string> --customer <string> [--name <string>]
FlagShorthandDescriptionRequired
--customer-cID of the customer this user is associated withtrue
--email-eemail addresstrue
--name-nname of the new userfalse
--role-rID of the role to assign the usertrue
# Add a new 'Member' user for customer 'My First Customer'
prism customers:users:create \
--email 'bar@email.com' \
--name 'Thomas Bar' \
--customer $(prism customers:list \
--columns id \
--no-header \
--filter 'name=My First Customer') \
--role $(prism me:roles \
--columns id \
--no-header \
--type customer \
--filter 'name=Member')

customers:users:delete

Delete a Customer User

prism customers:users:delete <user>
FlagShorthandDescriptionRequired
userID of the user to deletetrue

customers:users:list

List Customer Users

prism customers:users:list --customer <string> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--customer-cID of the customertrue
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

customers:users:roles

List Roles you can grant to Customer Users

prism customers:users:roles [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false
Customer User Roles

Click here for descriptions of roles that can be assigned to customer users


Instances CLI Commands

instances:config-vars:list

List Config Variables used on an Instance

prism instances:config-vars:list --instance <string> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--instance-iID of an instancetrue
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

instances:create

Create an Instance

prism instances:create --name <string> --integration <string> --customer <string> [--description <string>] [--credentials <string>] [--config-vars <string>]
FlagShorthandDescriptionRequired
--config-vars-vconfig variables to bind to steps of your instancefalse
--credentials-acredentials to bind to steps of your instancefalse
--customer-cID of customer to deploy totrue
--description-dlonger description of the instancefalse
--integration-iID of the integration this is an instance oftrue
--name-nname of your new instance.true
# Create an instance, tying specific $CREDENTIALS_IDs to a subset of actions
# for an integration $INTEGRATION_ID, and customer $CUSTOMER_ID
prism instances:create \
--name 'Pull and process SFTP data' \
--description 'Pull and process SFTP data for Thompson Family Farms' \
--integration ${INTEGRATION_ID} \
--customer ${CUSTOMER_ID} \
--credentials "[
{
\"action\": \"SW50ZWdyYXRpb25BY3Rpb25UeXBlOmRkYWNjMDk2LTg3MmEtNGYzZC1hYWQ2LWRkZDU3NmYwZjMwMg==\",
\"credential\": \"${CREDENTIALS_ID}\"
},
{
\"action\": \"SW50ZWdyYXRpb25BY3Rpb25UeXBlOjk2MjNmNTRjLWE1YjgtNDNkYy1hOGVlLTliMGY1YjJkMGRjMg==\",
\"credential\": \"${CREDENTIALS_ID}\"
},
{
\"action\": \"SW50ZWdyYXRpb25BY3Rpb25UeXBlOmRhNzE2NWUxLWNhZTYtNGU3My05M2UzLTc2OTc0MmU5ZDI0OA==\",
\"credential\": \"${CREDENTIALS_ID}\"
}]"

instances:credentials:list

List Credentials used on an Instance

prism instances:credentials:list --instance <string> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--instance-iID of an instancetrue
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

instances:delete

Delete an Instance

prism instances:delete <instance>
FlagShorthandDescriptionRequired
instanceID of the instance to deletetrue

instances:deploy

Deploy an Instance

prism instances:deploy <instance>
FlagShorthandDescriptionRequired
instanceID of an instancetrue

instances:disable

Disable an Instance

prism instances:disable <instance>
FlagShorthandDescriptionRequired
instanceID of an instancetrue

instances:enable

Enable an Instance

prism instances:enable <instance>
FlagShorthandDescriptionRequired
instanceID of an instancetrue

instances:list

List Instances

prism instances:list [--customer <string>] [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--customer-cID of a customerfalse
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

instances:test

Test an Instance of an Integration

prism instances:test <instance> [--extended] [--columns <string>] [--tail]
FlagShorthandDescriptionRequired
instanceID of an instance to testtrue
--columnsonly show provided columns (comma-separated)false
--extended-xshow extra columnsfalse
--tail-tTail logs of the instance test runfalse

instances:update

Update an Instance

prism instances:update <instance> [--config-vars <string>]
FlagShorthandDescriptionRequired
instanceID of an instancetrue
--config-vars-vconfig variables to bind to steps of your instancefalse

Integrations CLI Commands

integrations:create

Create an Integration

prism integrations:create --name <string> --description <string>
FlagShorthandDescriptionRequired
--description-dlonger description of the integrationtrue
--name-nname of the integration to createtrue

integrations:delete

Delete an Integration

prism integrations:delete <integration>
FlagShorthandDescriptionRequired
integrationID of the integration to deletetrue

integrations:export

Export an integration to a YAML file.

prism integrations:export <integration>
FlagShorthandDescriptionRequired
integrationID of an integration to exporttrue

integrations:fork

Fork an Integration

prism integrations:fork <parent> --name <string> --description <string>
FlagShorthandDescriptionRequired
parentID of the Integration to forktrue
--description-dlonger description of the forked integrationtrue
--name-nname of the forked integrationtrue

integrations:import

Import an Integration using a YAML definition file

prism integrations:import --path <string>
FlagShorthandDescriptionRequired
--path-ppath to the YAML definition of the integration to importtrue

integrations:list

List Integrations

prism integrations:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

integrations:publish

Publish a version of an Integration for use in Instances

prism integrations:publish <integration>
FlagShorthandDescriptionRequired
integrationID of an integration to publishtrue

integrations:required-config-vars:create

Create a Required Config Variable for an integration

prism integrations:required-config-vars:create --integration <string> --key <string> [--default-value <string>]
FlagShorthandDescriptionRequired
--default-value-dvalue of the config variablefalse
--integration-iID of the integrationtrue
--key-kkey used to identify a config variabletrue

integrations:required-config-vars:delete

Delete a Required Config Variable

prism integrations:required-config-vars:delete <required-config-variable>
FlagShorthandDescriptionRequired
required-config-variableID of the required config variable to deletetrue

integrations:required-config-vars:list

List Required Config Variables for an Integration

prism integrations:required-config-vars:list --integration <string> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--integration-iID of an integrationtrue
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

integrations:show

Show details of an Integration

prism integrations:show <integration> [--actions]
FlagShorthandDescriptionRequired
integrationID of an integrationtrue
--actions-afalse

integrations:steps:add

Add a Step to an Integration

prism integrations:steps:add <action> --integration <string> [--inputs <string>] [--outputs <string>]
FlagShorthandDescriptionRequired
actionID of an action to add as steptrue
--inputs-iinputs to the stepfalse
--integrationID of the integration to add the step totrue
--outputs-ooutputs from the step to capturefalse
Capturing Output

See output expressions for information on how to capture outputs of an action.

# Add the HTTP GET action as a step to an integration named "My Sample Integration"
prism integrations:steps:add \
$(prism components:actions:list \
--filter 'key=httpGet' \
--columns id \
--no-header) \
--integration \
$(prism integrations:list \
--filter 'name=My Sample Integration' \
--columns id \
--no-header) \
--inputs '[
{
"name": "url",
"expression": "'"'"'https://jsonplaceholder.typicode.com/todos'"'"'"
}
]' \
--outputs '[
{
"name": "todosOutput",
"expression": "$"
}
]'

integrations:steps:delete

Remove a Step from an Integration

prism integrations:steps:delete <step>
FlagShorthandDescriptionRequired
stepID of step to remove from an integrationtrue

integrations:steps:list

List Steps of an Integration

prism integrations:steps:list <integration> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
integrationID of an integrationtrue
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

integrations:test

Run a test of an Integration

prism integrations:test <integration> [--extended] [--columns <string>] [--tail] [--payload <string>] [--run-to <string>]
FlagShorthandDescriptionRequired
integrationID of an integration to testtrue
--columnsonly show provided columns (comma-separated)false
--extended-xshow extra columnsfalse
--payload-pOptional JSON-formatted data payload to submit with the testfalse
--run-to-rStep order to run the integration up tofalse
--tail-tTail logs of the integration test runfalse
# Test an integration named 'My Integration' and tail log output
prism integrations:test \
--tail \
$(prism integrations:list \
--columns id \
--no-header \
--filter name='My Integration')

integrations:triggers:add

Add a Trigger to an Integration

prism integrations:triggers:add <trigger> --integration <string> [--inputs <string>] [--outputs <string>]
FlagShorthandDescriptionRequired
triggerID of the trigger to addtrue
--inputs-iinputs to pass the triggerfalse
--integrationID of the integration to add the trigger totrue
--outputs-ooutputs to capture from the triggerfalse

integrations:triggers:delete

Remove a Trigger from an Integration

prism integrations:triggers:delete <trigger>
FlagShorthandDescriptionRequired
triggerID of the trigger to removetrue

integrations:triggers:list

List Triggers of an Integration

prism integrations:triggers:list <integration> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
integrationID of an integrationtrue
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

integrations:update

Update an Integration's name or description

prism integrations:update <integration> [--name <string>] [--description <string>] [--test-credentials <string>] [--test-config-vars <string>] [--default-config-vars <string>]
FlagShorthandDescriptionRequired
integrationID of an integrationtrue
--default-config-varsJSON-formatted default values for config variables that are replaced with instance or test config variablesfalse
--description-dnew description to give the integrationfalse
--name-nnew name to give the integrationfalse
--test-config-varsJSON-formatted config variables to be used for testingfalse
--test-credentialscredentials to bind to steps of the integration for testingfalse

integrations:versions

List Integration Versions.

prism integrations:versions <integration> [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
integrationID of an integrationtrue
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

Login CLI Commands

login

Log in to your Prismatic account

prism login [--force]
FlagShorthandDescriptionRequired
--force-fre-authenticate, even if you are already logged infalse

Logout CLI Commands

logout

Log out of your Prismatic account

prism logout [--browser]
FlagShorthandDescriptionRequired
--browser-badditionally log out of your default browser's sessionfalse

Logs CLI Commands

logs:severities:list

List Log Severities for use by Alert Triggers

prism logs:severities:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

Me CLI Commands

me

Print your user profile information

prism me

me:token

Print your JWT authorization token

prism me:token

Organization CLI Commands

organization:config-vars:create

Create an Organization-level Config Variable

prism organization:config-vars:create --key <string> --value <string>
FlagShorthandDescriptionRequired
--key-kkey used to identify a config variabletrue
--value-vvalue of the config variabletrue

organization:config-vars:delete

Delete an Organization Config Variable

prism organization:config-vars:delete <config-variable>
FlagShorthandDescriptionRequired
config-variableID of the config variable to deletetrue

organization:config-vars:list

List Config Variables available to the entire Organization

prism organization:config-vars:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

organization:credentials:create

Create a set of Organization-level Credentials for use by Instance Actions

prism organization:credentials:create --label <string> --authorization-method <string> [--fields <string>]
FlagShorthandDescriptionRequired
--authorization-method-aID of the authorization methodtrue
--fields-fusername, password, etc., in JSON formatfalse
--label-lname to give the new credentialstrue
# Create basic auth for REST resource at website.com/resource
prism organization:credentials:create \
--label 'User/pass for website.com/resource' \
--authorization-method basic \
--fields '{"username": "myuser", "password": "MyP@$sW0Rd!"}'

organization:credentials:delete

Delete an Organization Credential

prism organization:credentials:delete <credential>
FlagShorthandDescriptionRequired
credentialID of the credential to deletetrue

organization:credentials:list

List Credentials available to the entire Organization

prism organization:credentials:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

organization:update

Update an Organization

prism organization:update [--name <string>] [--config-vars <string>]
FlagShorthandDescriptionRequired
--config-vars-vJSON-formatted config variablesfalse
--name-nname of the organizationfalse

organization:users:create

Create a User for your Organization

prism organization:users:create [--name <string>] --email <string> --role <string>
FlagShorthandDescriptionRequired
--email-eemail address of the usertrue
--name-nname of the userfalse
--role-rrole the user should assumetrue
Organization Roles

See the users page for information on roles that users can assume

# Create an organization user for Susan and grant her the 'Integrator' role
prism organization:users:create \
--email 'foo@email.com' \
--name 'Susan Foo' \
--role $(prism me:roles \
--columns id \
--no-header \
--filter 'name=Integrator')

organization:users:delete

Delete an Organization User

prism organization:users:delete <user>
FlagShorthandDescriptionRequired
userID of the user to deletetrue

organization:users:list

List Users of your Organization

prism organization:users:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

organization:users:roles

List Roles you can grant to other users in your Organization

prism organization:users:roles [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false

Register CLI Commands

register

Register with Prismatic

prism register --organization <string> --email <string> [--password <string>]
FlagShorthandDescriptionRequired
--email-eyour email addresstrue
--organization-oname of the organization to createtrue
--password-pyour password (you'll be prompted if not specified)false
Creating an organization

By registering with Prismatic you are creating a new organization. To add a user to an existing organization, use the organization:users:create command.


Triggers CLI Commands

triggers:list

List types of triggers that can trigger integrations

prism triggers:list [--columns <string>] [--sort <string>] [--filter <string>] [--csv] [--output {csv,json,yaml}] [--extended] [--no-truncate] [--no-header]
FlagShorthandDescriptionRequired
--columnsonly show provided columns (comma-separated)false
--csvoutput is csv format [alias: --output=csv]false
--extended-xshow extra columnsfalse
--filterfilter property by partial string matching, ex: name=foofalse
--no-headerhide table header from outputfalse
--no-truncatedo not truncate output to fit screenfalse
--output ['csv', 'json', 'yaml']output in a more machine friendly formatfalse
--sortproperty to sort by (prepend '-' for descending)false
# Get the ID of the 'webhook' trigger for an integration
prism triggers:list --filter 'key=webhook' --columns id --no-header
Last updated on