v1packs

Get list of installed packs.

Query parameters
exclude_attributes
array[string]
List of attributes to exclude
include_attributes
array[string]
List of attributes to include
limit
integer
Number of packs to get
offset
integer
Number of packs to offset
sort
string
Comma-separated list of fields to sort by
id
array[string]
Entity id filter
name
string
Entity name filter
ref
string
Entity ref filter
Responses

List of installed packs.

array[object]
author
string
Author of the pack.
description
string
Description of the pack.
name
string
Name of the pack.
ref
string
Reference of the pack.
version
string
Version of the pack.
content
object
Content type in the pack.
keywords
array[string]
Keywords associated with the pack.
repo_url
string
URL of the Pack's repo.

To list all the packs of all indexes used by your StackStorm instance.

Responses

Pack index.

object
indexes
object
Index details.
count
integer
Number of index.
errors
object
Errors.
invalid
integer
Invalid.
status
array
Status of the index.
valid
integer
Valid.
packs
object
Number of packs in the index.

To get the state of all indexes used by your StackStorm instance.

Responses

Index health.

object
indexes
object
Index details.
count
integer
Number of index.
errors
object
Errors.
invalid
integer
Invalid.
status
array
Status of the index.
valid
integer
Valid.
packs
object
Number of packs in the index.

Search the index with a query or Get information about an available pack from the index.

Request body

A query to search a pack or a pack name to get its details

object
pack
string
Name of the pack to show.
query
string
Search query.
Responses

Pack search results.

array, object

Install new packs..

Request body

Packs to be installed

object
packs
array[string]
ref of the packs in Exchange, or a git repo URL.
python3
boolean
Use Python 3 binary for pack virtual environment.
force
boolean
Force pack installation.
Responses

Pack installation request has been accepted

object
execution_id
string
required

Register pack(s): sync all file changes with DB.

Request body

Pack(s) to be Registered

object
packs
array[string]
ref of the packs in Exchange, or a git repo URL.
types
array[string]
Types of content to register.
Responses

Pack(s) Registered.

object
author
string
Author of the pack.
description
string
Description of the pack.
name
string
Name of the pack.
ref
string
Reference of the pack.
version
string
Version of the pack.
content
object
Content type in the pack.
keywords
array[string]
Keywords associated with the pack.
repo_url
string
URL of the Pack's repo.
Request body

Packs to be uninstalled

object
ref_or_id
string
ref or id of the pack
packs
array[string]
Name of the packs in Exchange, or a git repo URL.
Responses

Pack uninstallation request has been accepted

object
execution_id
string
required

Get information about an installed pack.

Path parameters
ref_or_id
string
Reference of the pack.
required
file_path
string
Path to the file.
required
Header parameters
if-none-match
string
ETag to compare to.
if-modified-since
string
Date of last known modification.
Responses

Content of the file.

null

Get information about an installed pack.

Path parameters
ref_or_id
string
Reference of the pack.
required
Responses

Information about a pack.

array[object]
author
string
Author of the pack.
description
string
Description of the pack.
email
string
Email of the author.
keywords
array[string]
Keywords associated with the pack.
name
string
Name of the pack.
version
string
Version of the pack.

Get information about an installed pack.

Path parameters
ref_or_id
string
Reference of the pack.
required
Responses

Information about a pack.

object
author
string
Author of the pack.
description
string
Description of the pack.
email
string
Email of the author.
keywords
array[string]
Keywords associated with the pack.
name
string
Name of the pack.
version
string
Version of the pack.