Sentry API

  • API Docs for Version: 0.1.0

    • Show:

    Projects

    Provides methods for interacting with Projects in the Sentry API.

    Table of Contents

    Constructor

    Projects
    (
    • client
    )

    Defined in lib/projects.js:3

    Parameters:

    Methods

    createKey
    (
    • orgSlug
    • projectSlug
    • body
    • callback
    )
    Promise

    Defined in lib/projects.js:88

    Create a new client key.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • body Object
      • name String

        The name for the new key.

    • callback Function

    Returns:

    Promise
    delete
    (
    • orgSlug
    • projectSlug
    • callback
    )
    Promise

    Defined in lib/projects.js:28

    Delete a project.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • callback Function

    Returns:

    Promise
    deleteKey
    (
    • orgSlug
    • projectSlug
    • keyId
    • callback
    )
    Promise

    Defined in lib/projects.js:104

    Delete a client key.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • keyId String

      The ID of the key to delete.

    • callback Function

    Returns:

    Promise
    get
    (
    • orgSlug
    • projectSlug
    • callback
    )
    Promise

    Defined in lib/projects.js:14

    Retrieve a project.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • callback Function

    Returns:

    Promise
    keys
    (
    • orgSlug
    • projectSlug
    • callback
    )
    Promise

    Defined in lib/projects.js:74

    List a project's client keys.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • callback Function

    Returns:

    Promise
    releases
    (
    • orgSlug
    • projectSlug
    • callback
    )
    Promise

    Defined in lib/projects.js:165

    List a project's releases.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • callback Function

    Returns:

    Promise
    stats
    (
    • orgSlug
    • projectSlug
    • callback
    )
    Promise

    Defined in lib/projects.js:60

    Retrieve event counts for a project.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • callback Function

    Returns:

    Promise
    tag
    (
    • orgSlug
    • projectSlug
    • key
    • callback
    )
    Promise

    Defined in lib/projects.js:150

    List a tag's values.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • key String

      The tag to lookup.

    • callback Function

    Returns:

    Promise
    update
    (
    • orgSlug
    • projectSlug
    • body
    • callback
    )
    Promise

    Defined in lib/projects.js:42

    Update a project.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • body Object
      • name String

        The new name for the project.

      • slug String

        The new slug for the project.

      • options Object

        Optional options to override in the project settings.

    • callback Function

    Returns:

    Promise
    updateKey
    (
    • orgSlug
    • projectSlug
    • key
    • body
    • callback
    )
    Promise

    Defined in lib/projects.js:119

    Update a client key.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • key type

      [description]

    • body Object
      • name String

        The new name for the key.

    • callback Function

    Returns:

    Promise
    users
    (
    • orgSlug
    • projectSlug
    • callback
    )
    Promise

    Defined in lib/projects.js:136

    List a project's users.

    Parameters:

    • orgSlug String

      Organization slug.

    • projectSlug String

      Project slug.

    • callback Function

    Returns:

    Promise