> ## Documentation Index
> Fetch the complete documentation index at: https://astronomer.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Deployment logs

> Get logs for an Astro Deployment. You must specify at least one log source.



## OpenAPI

````yaml /astro/api/v-1/openapi.yaml get /organizations/{organizationId}/deployments/{deploymentId}/logs
openapi: 3.0.3
info:
  contact: {}
  description: Astro Platform API
  title: Astro Platform API
  version: v1.0
servers:
  - url: https://api.astronomer.io/v1
security:
  - JWT: []
tags:
  - description: >-
      The `organization` object contains the metadata and configurations of an
      Astro Organization. It does not include objects within the Organization,
      such as users and clusters. Make requests to `organization` endpoints to
      view and update high level settings for your Organization, including
      settings related to authentication and billing. To manage resources within
      an Organization, make requests to the endpoints related to those
      resources, such as `users`. See
      [Billing](https://astronomer.io/docs/astro/manage-billing), [Set up single
      sign-on](https://astronomer.io/docs/astro/configure-idp), and [Manage
      domains](https://astronomer.io/docs/astro/manage-domains).
    name: Organization
  - description: >-
      The `deployment` object represents an Astro Deployment, which is a hosted
      Airflow environment that is powered by all core Airflow components,
      including schedulers and workers. Make requests to the `deployment` object
      to create, update, or delete a Deployment or its computational resources.
      See [Deployment
      settings](https://astronomer.io/docs/astro/deployment-settings).
    name: Deployment
  - description: >-
      A `cluster` object represents an Astro cluster, which is a Kubernetes
      cluster that hosts the infrastructure required to run Deployments. Make
      requests to `cluster` endpoints to manage your standard and dedicated
      clusters. See [Create a dedicated
      cluster](https://astronomer.io/docs/astro/create-dedicated-cluster).
    name: Cluster
  - description: >-
      The `workspace` object represents an Astro Workspace, which is a
      collection of Deployments that can be accessed by a specific group of
      users. It contains metadata about a Workspace, but does not contain
      objects within the Workspace such as users and Deployments. Make requests
      to `workspace` endpoints to manage high level details about your
      Workspace. To manage resources within a Workspace, make requests to the
      endpoints related to those resources, such as `users`, and use the
      `workspaceIds` parameter to filter results by Workspace. See [Configure
      Workspaces](https://astronomer.io/docs/astro/manage-workspaces).
    name: Workspace
  - description: >-
      The `user` object represents a user account in your Astro Organization.
      Astro creates a new `user` object whenever you invite a user by email or
      add a user to Astro through an identity provider. The object contains all
      information about a user, including their personal information, roles, and
      login attempts. It doesn't include attributes for actions that the user
      completes after they log in, such as updating a Deployment. Make requests
      to `user` endpoints to manage permissions for existing users both at the
      Organization and Workspace level. To create new users, make requests to
      `invite` endpoints instead.
    name: User
  - description: >-
      The `team` object represents an Astro Team, which is a group of users that
      share the same permissions across your Organization and Workspaces. Make
      requests to `team` endpoints to create, update, and delete Teams across an
      Organization. See [Configure Teams on
      Astro](https://astronomer.io/docs/astro/manage-teams).
    name: Team
  - description: >-
      The `apitoken` object represents a single API token within your
      Organization. API tokens are used to authenticate automated tools and
      processes to your Organization. They have varying levels of access to your
      resources based on their Organization, Workspace, and Deployment roles.
      See [Workspace API tokens](workspace-api-tokens.md) and [Organization API
      tokens](organization-api-tokens.md).
    name: api-token
    x-group: API Token
  - name: allowed-ip-address-range
    x-group: Allowed IP Address Range
  - name: agent-token
    x-group: Agent Token
paths:
  /organizations/{organizationId}/deployments/{deploymentId}/logs:
    get:
      tags:
        - Deployment
      summary: Get Deployment logs
      description: >-
        Get logs for an Astro Deployment. You must specify at least one log
        source.
      operationId: GetDeploymentLogs
      parameters:
        - description: The ID of the Organization to which the Deployment belongs.
          in: path
          name: organizationId
          required: true
          schema:
            type: string
        - description: The ID of the Deployment to get logs for.
          in: path
          name: deploymentId
          required: true
          schema:
            type: string
        - description: Log sources to retrieve.
          in: query
          name: sources
          required: true
          schema:
            items:
              enum:
                - scheduler
                - triggerer
                - worker
                - webserver
                - dag-processor
                - apiserver
              type: string
            type: array
        - description: Maximum number of log entries per page.
          in: query
          name: limit
          schema:
            default: 500
            minimum: 1
            type: integer
        - description: Offset for pagination.
          in: query
          name: offset
          schema:
            default: 0
            minimum: 0
            type: integer
        - description: Range of the log search in seconds.
          in: query
          name: range
          schema:
            default: 3600
            minimum: 60
            type: integer
        - description: Maximum total number of results across all pages.
          in: query
          name: maxNumResults
          schema:
            default: 10000
            minimum: 1
            type: integer
        - description: Search ID for paginated results.
          in: query
          name: searchId
          schema:
            type: string
        - description: Text to filter logs by.
          in: query
          name: searchText
          schema:
            type: string
        - description: Start of time range (RFC3339).  Must  be  used  with  endDate.
          in: query
          name: startDate
          schema:
            format: date-time
            type: string
        - description: End of time range (RFC3339).    Must  be  used  with  startDate.
          in: query
          name: endDate
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentLog'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal Server Error
      security:
        - JWT: []
components:
  schemas:
    DeploymentLog:
      properties:
        limit:
          description: The requested log entry limit.
          minimum: 1
          type: integer
        maxNumResults:
          description: The maximum number of results.
          minimum: 0
          type: integer
        offset:
          description: The offset of the current results page.
          minimum: 0
          type: integer
        resultCount:
          description: The number of results returned.
          minimum: 0
          type: integer
        results:
          description: The log entries.
          items:
            $ref: '#/components/schemas/DeploymentLogEntry'
          type: array
        searchId:
          description: The search ID for pagination.
          type: string
      required:
        - limit
        - maxNumResults
        - offset
        - resultCount
        - results
        - searchId
      type: object
    Error:
      properties:
        fieldErrors:
          description: >-
            FieldErrors carries one entry per failed request-validation
            constraint.

            Only present on 400 responses caused by request binding/validation.
          items:
            $ref: '#/components/schemas/FieldValidationError'
          type: array
        message:
          type: string
        requestId:
          type: string
        statusCode:
          maximum: 600
          minimum: 400
          type: integer
      required:
        - message
        - requestId
        - statusCode
      type: object
    DeploymentLogEntry:
      properties:
        raw:
          description: The raw log entry content.
          type: string
        source:
          description: The log entry source.
          enum:
            - scheduler
            - webserver
            - triggerer
            - worker
            - dag-processor
            - apiserver
          type: string
        timestamp:
          description: The log entry's timestamp.
          type: number
      required:
        - raw
        - source
        - timestamp
      type: object
    FieldValidationError:
      properties:
        code:
          type: string
        field:
          type: string
        message:
          type: string
      required:
        - code
        - field
        - message
      type: object
  securitySchemes:
    JWT:
      scheme: bearer
      type: http

````