1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. StackMetadata

StackMetadata

    StackMetadata returns metadata about a stack.

    Properties

    • orgName string required
      The organization that owns the stack.
    • projectName string required
      The project that contains the stack.
    • stackName string required
      The stack name within the project.
    • ownedBy UserInfo required
      The user with ownership of this stack
    • ↳ name string required
      The user’s display name.
    • ↳ githubLogin string required
      The user’s login name.
    • ↳ avatarUrl string required
      The URL of the user’s avatar image.
    • ↳ email string optional
      IMPORTANT: The email address of the user is only included on a few admin-only APIs. For nearly all APIs that return a UserInfo object, this will not be provided. considered sensitive information.
    • notificationSettings StackNotificationSettings required
      The notification settings for this stack.
    • ↳ notifyUpdateFailure boolean required
      Whether to send a notification when a stack update fails.
    • ↳ notifyUpdateSuccess boolean required
      Whether to send a notification when a stack update succeeds.