LIliongard
Environment

List of Environments

Changed on
get/environments

Request

  • Base URL
    https://example.app.liongard.com/api/v2
  • URL
    https://example.app.liongard.com/api/v2/environments
  • Auth
    API key in header X-ROAR-API-KEY

Query parameters

pageinteger

A integer indicating the current page index

pageSizeinteger

A integer indicating the current page size

columnsstring

A comma-separated string indicating the columns

orderBystring

A string containing the response order

Response

Success

Successboolean

Example response

{
  "Success": true,
  "Data": [
    {
      "Name": "Contoso Nation",
      "Visible": true,
      "ExpiresOn": "2018-02-01T18:31:22.896Z",
      "LastKeyRotation": "2018-02-01T18:31:22.896Z",
      "CreatedOn": "2018-02-01T18:31:22.896Z",
      "UpdatedOn": "2018-02-01T18:31:22.896Z",
      "Tier": {
        "CanDownGrade": true
      },
      "UpdatedBy": {
        "FirstName": "John",
        "LastName": "Doe",
        "FullName": "John Doe",
        "Email": "JDoe@contoso.com",
        "Username": "j.doe.contoso",
        "MfaFactorAuth": true,
        "Status": "active",
        "Owner": true,
        "Visibile": true,
        "Locked": true,
        "Department": "Other",
        "ReceiveTechUpdates": true,
        "LastLogin": "2018-02-01T18:31:22.896Z",
        "CreatedOn": "2018-02-01T18:31:22.896Z",
        "UpdatedOn": "2018-02-01T18:31:22.896Z",
        "Groups": []
      },
      "CreatedBy": {
        "FirstName": "John",
        "LastName": "Doe",
        "FullName": "John Doe",
        "Email": "JDoe@contoso.com",
        "Username": "j.doe.contoso",
        "MfaFactorAuth": true,
        "Status": "active",
        "Owner": true,
        "Visibile": true,
        "Locked": true,
        "Department": "Other",
        "ReceiveTechUpdates": true,
        "LastLogin": "2018-02-01T18:31:22.896Z",
        "CreatedOn": "2018-02-01T18:31:22.896Z",
        "UpdatedOn": "2018-02-01T18:31:22.896Z",
        "Groups": []
      }
    }
  ]
}

Changes

  • a12275308587Revision changes
    • breaking

      the response's body type changed from array to object for status

    • warning

      deleted the query request parameter conditions[]

    • warning

      deleted the query request parameter fields[]

    • info

      api operation id GetEnvironments removed and replaced with

    • info

      api tag Environment added

    • info

      api tag Environments removed

    • info

      added the new optional query request parameter columns

    • info

      added the new optional query request parameter orderBy

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter pageSize

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status