Skip to main content

Update dashboard folder

PUT 
/perses-public/api/v1/projects/:projectId

Replaces the folder's Perses project document with the body you send.

Send the complete document. The stored one is replaced rather than merged, so a property you leave out is cleared, and the folder's name is set from spec.display.name.

The body is validated before anything is written. A document that isn't a complete Perses project document is rejected with 400, and the stored folder is left untouched.

Request​

Path Parameters

    projectId stringrequired

    The folder's id.

Body

required
    kind stringrequired

    Possible values: [Project]

    metadata objectrequired
    name stringrequired

    The folder's identity. Required, must be non-empty, and has to be unique within the account.

    spec objectrequired
    display objectrequired

    How the folder is labelled in the app. Required on both create and update.

    name stringrequired

    The name shown in the app. Required, and must be non-empty. On an update it also becomes the folder's name.

    description string

Responses​

The updated folder.

Schema
    id string

    The folder's identifier, and the only way to address it.

    name string

    The folder's name. Set from metadata.name when the folder is created, and replaced by spec.display.name on an update or by newProjectName on a rename.

    doc object

    A Perses project document. This is the request body for creating and updating a dashboard folder.

    kind stringrequired

    Possible values: [Project]

    metadata objectrequired
    name stringrequired

    The folder's identity. Required, must be non-empty, and has to be unique within the account.

    spec objectrequired
    display objectrequired

    How the folder is labelled in the app. Required on both create and update.

    name stringrequired

    The name shown in the app. Required, and must be non-empty. On an update it also becomes the folder's name.

    description string
    entityId integer

    Internal handle for the account that owns the folder.

    createdBy integer

    Numeric id of the principal that created the folder. For a folder created through this API this is the id of the API token, not of a user.

    updatedBy integer
    createdAt date-time
    updatedAt date-time
    isDeleted boolean

    Returned as true or false by create, update and rename, and as 1 or 0 by the list, get and search endpoints.

    deletedAt date-time

    Null unless the folder was deleted.

    deletedBy integer

    Null unless the folder was deleted.

Loading...