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

OrgEnvironment represents an environment within an organization.

Properties

• id string required
  The unique identifier of the environment.
• organization string required
  The login name of the organization that owns this environment.
• project string optional
  The project name that contains this environment, if project-scoped.
• name string required
  The name of the environment.
• created string required
  The ISO 8601 timestamp when the environment was created.
• modified string required
  The ISO 8601 timestamp when the environment was last modified.
• ownedBy UserInfo required
  The user with ownership of this environment
• ↳ 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.
• tags map[string]string required
  User-defined key-value tags associated with the environment for organization and filtering.
• deletedAt string optional
  The ISO 8601 timestamp when the environment was soft-deleted, or null if not deleted.
• links EnvironmentLinks optional
  Hypermedia links related to the environment.
• ↳ self string optional
  The URL for this environment resource.
• referrerMetadata EnvironmentReferrerMetadata required
  Metadata about what refers to this environment.
• ↳ environmentReferrerCount integer required
  The number of environments that reference this environment.
• ↳ stackReferrerCount integer required
  The number of stacks that reference this environment.
• ↳ insightsAccountReferrerCount integer required
  The number of Insights accounts that reference this environment.
• settings EnvironmentSettings required
  Configuration settings for the environment, such as deletion protection.
• ↳ deletionProtected boolean required
  Whether the environment is protected from deletion.