Open in Claude Open in ChatGPT

Stack

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Stack is contained within a Platform.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
key string No

Methods

The following methods are available:

Add Team Member

Adds a principal as a member of a Team against the given stack
POST /stacks/{stackId}/teams/{teamKey}/members/add

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team
id true string

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Assign Datastores

POST /stacks/{stackId}/datastores/assign

Parameters

Name Required Type Description
stackId true string The ID of the stack
type true string
id true string
key false string

Check Membership

Checks whether a principal belongs to a Team for the given stack
POST /stacks/{stackId}/teams/{teamKey}/members/check

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team
id true string

Response

{
  "type": "object",
  "description": "Belongs",
  "extends": "status",
  "properties": {
    "belongs": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check Permission

Checks whether one or more authorities against the specified stack are granted for a given set of users
POST /stacks/{stackId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
stackId true string The ID of the stack
permissionId true string The ID of the permission
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified stack for the given user
POST /stacks/{stackId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
stackId true string The ID of the stack
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified stack are granted for a given set of users
POST /stacks/authorities/check

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified stack are granted for a given set of users
POST /stacks/permissions/check

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Create Role

Creates a role for a stack
POST /stacks/{stackId}/roles

Parameters

Name Required Type Description
stackId true string The ID of the stack
HTTP Payload true string HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Create Stack

Creates a new Stack
POST /stacks

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Create a Team

Creates a Team against the given stack
POST /stacks/{stackId}/teams

Parameters

Name Required Type Description
stackId true string The ID of the stack

Response

{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Delete Attachment

Deletes an attachment
DELETE /stacks/{stackId}/attachments/{attachmentId}

Parameters

Name Required Type Description
stackId true string The ID of the stack
attachmentId true string

Delete Role

Deletes a role for a stack
POST /stacks/{stackId}/roles/{roleKeyOrId}/delete

Parameters

Name Required Type Description
stackId true string The ID of the stack
roleKeyOrId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Role

Deletes a role for a stack
DELETE /stacks/{stackId}/roles/{roleKeyOrId}

Parameters

Name Required Type Description
stackId true string The ID of the stack
roleKeyOrId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Stack

Deletes an existing Stack
DELETE /stacks/{stackId}

Parameters

Name Required Type Description
stackId true string The ID of the stack

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Stack

Deletes an existing Stack
POST /stacks/{stackId}/delete

Parameters

Name Required Type Description
stackId true string The ID of the stack

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Deletes a Team

Deletes a Team against the given stack
DELETE /stacks/{stackId}/teams/{teamKey}

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Download Attachment

Downloads an attachment
GET /stacks/{stackId}/attachments/{attachmentId}

Parameters

Name Required Type Description
stackId true string The ID of the stack
attachmentId true string

Download Preview

Downloads a preview stream of a stack attachment
GET /stacks/{stackId}/preview/{name}

Parameters

Name Required Type Description
stackId true string The ID of the stack
name true string

Exists Datastores

POST /stacks/{stackId}/datastores/exists

Parameters

Name Required Type Description
stackId true string The ID of the stack
key true string

Export Stack

Starts an export job for this resource
POST /stacks/{stackId}/export

Parameters

Name Required Type Description
stackId true string The ID of the stack
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object",
      "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports."
    },
    "endDate": {
      "type": "object",
      "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports."
    },
    "startChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or beyond the specified changeset."
    },
    "endChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or before the specified changeset."
    },
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during export."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during export."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during export."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during export."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during export."
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Get Team

Retrieves a Team against the given stack
GET /stacks/{stackId}/teams/{teamKey}

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team

Response

{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Grant Authority

Grants an authority against the specified stack to a given user
POST /stacks/{stackId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
stackId true string The ID of the stack
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Grant Authority to Team

Assigns an Authority to a Team for the given stack
POST /stacks/{stackId}/teams/{teamKey}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team
authorityId true string The ID or authority key for the authority

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Import Stack

Starts an import job for this resource
POST /stacks/{stackId}/import

Parameters

Name Required Type Description
stackId true string The ID of the stack
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during import."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during import."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during import."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during import."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during import."
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": "CLONE",
      "description": "Either CLONE or COPY_EVERYTHING. Use CLONE to keep the same IDs on import. Use COPY_EVERYTHING to generate all new IDs for all entries on every import."
    },
    "substitutions": {
      "type": "string"
    }
  }
}

List Attachments

Lists the attachments for a stack
GET /stacks/{stackId}/attachments

Parameters

Name Required Type Description
stackId true string The ID of the stack

List Datastores

GET /stacks/{stackId}/datastores

Parameters

Name Required Type Description
stackId true string The ID of the stack

List Logs

GET /stacks/{stackId}/logs

Parameters

Name Required Type Description
stackId true string The ID of the stack

List Roles

Lists the roles for a stack
GET /stacks/{stackId}/roles

Parameters

Name Required Type Description
stackId true string The ID of the stack
inherited false string

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}

List Team Authorities

Retrieves a list of the authorities defined to be granted by a Team
GET /stacks/{stackId}/teams/{teamKey}/authorities

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team

Response

{
  "type": "object",
  "description": "List of Authorities",
  "properties": {
    "authorities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

List Teams

Lists the Teams against the given stack
GET /stacks/{stackId}/teams

Parameters

Name Required Type Description
stackId true string The ID of the stack

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Lists Stack

Retrieves a list of Stack instances
GET /stacks

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_stack"
      }
    }
  }
}

Lists Team Members

Lists the members of a Team against the given stack
GET /stacks/{stackId}/teams/{teamKey}/members

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Logfile Logs

GET /stacks/{stackId}/logs/logfile

Parameters

Name Required Type Description
stackId true string The ID of the stack

Queries for Stack

Queries for instances of type Stack
POST /stacks/query

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_stack"
      }
    }
  }
}

Query

Queries for matches
POST /stacks/{stackId}/datastores/query

Parameters

Name Required Type Description
stackId true string The ID of the stack
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}

Query

Queries for matches
POST /stacks/{stackId}/logs/query

Parameters

Name Required Type Description
stackId true string The ID of the stack
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified stack
GET /stacks/{stackId}/acl/list

Parameters

Name Required Type Description
stackId true string The ID of the stack

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Reads the ACL for a stack and specific actor
GET /stacks/{stackId}/acl

Parameters

Name Required Type Description
stackId true string The ID of the stack
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified stack
POST /stacks/{stackId}/authorities

Parameters

Name Required Type Description
stackId true string The ID of the stack

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Datastore

GET /stacks/{stackId}/datastores/{key}

Parameters

Name Required Type Description
stackId true string The ID of the stack
key true string

Read Datastore Type

GET /stacks/find/{datastoreType}/{datastoreId}

Parameters

Name Required Type Description
datastoreType true string
datastoreId true string

Read Log

GET /stacks/{stackId}/logs/{logEntryId}

Parameters

Name Required Type Description
stackId true string The ID of the stack
logEntryId true string The ID of the log entry

Read Role

Reads a role for a stack
GET /stacks/{stackId}/roles/{roleKeyOrId}

Parameters

Name Required Type Description
stackId true string The ID of the stack
roleKeyOrId true string
inherited false string

Response

{
  "$ref": "#/components/schemas/"
}

Read Stack

Reads an instance of a Stack
GET /stacks/{stackId}

Parameters

Name Required Type Description
stackId true string The ID of the stack

Response

{
  "type": "object",
  "extends": "document",
  "description": "Stack",
  "container": "platform",
  "properties": {
    "key": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  }
}

Remove Team Member

Remove a principal from a team's membership list
POST /stacks/{stackId}/teams/{teamKey}/members/remove

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Revoke Authority

Revokes an authority against the specified stack from a given user
POST /stacks/{stackId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
stackId true string The ID of the stack
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Revoke Authority from Team

Revokes an Authority from a Team for the given stack
POST /stacks/{stackId}/teams/{teamKey}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team
authorityId true string The ID or authority key for the authority

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Summarize Access Policy

Retrieves an access policy summary for a Team on the given stack
GET /stacks/{stackId}/teams/{teamKey}/access/policies/summary

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team
scope false string
info false string
order false string

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Unassign Datastores

POST /stacks/{stackId}/datastores/unassign

Parameters

Name Required Type Description
stackId true string The ID of the stack
key true string

Update Role

Updates a role for a stack
PUT /stacks/{stackId}/roles/{roleKeyOrId}

Parameters

Name Required Type Description
stackId true string The ID of the stack
roleKeyOrId true string
HTTP Payload true string HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Role

Updates a role for a stack
POST /stacks/{stackId}/roles/{roleKeyOrId}/update

Parameters

Name Required Type Description
stackId true string The ID of the stack
roleKeyOrId true string
HTTP Payload true string HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Stack

Updates an existing Stack
PUT /stacks/{stackId}

Parameters

Name Required Type Description
stackId true string The ID of the stack

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Stack

Updates an existing Stack
POST /stacks/{stackId}/update

Parameters

Name Required Type Description
stackId true string The ID of the stack

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update a Team

Updates a Team against the given stack
PUT /stacks/{stackId}/teams/{teamKey}

Parameters

Name Required Type Description
stackId true string The ID of the stack
teamKey true string The key identifier for the team

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Upload Attachment

Uploads an attachment
POST /stacks/{stackId}/attachments/{attachmentId}

Parameters

Name Required Type Description
stackId true string The ID of the stack
attachmentId true string

Upload Attachments

Uploads one or more attachments
POST /stacks/{stackId}/attachments

Parameters

Name Required Type Description
stackId true string The ID of the stack

Schema


{
  "type": "object",
  "extends": "document",
  "description": "Stack",
  "container": "platform",
  "properties": {
    "key": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  },
  "id": "stack"
}