Skip to main content

Search Milestones​

Returns a list of reached instance usage milestones.

Request Body required
    query object

    Object unspecific list filters like offset, limit and asc/desc.

    offset uint64
    limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

    sortingColumn the field the result is sorted

    Possible values: [MILESTONE_FIELD_NAME_UNSPECIFIED, MILESTONE_FIELD_NAME_TYPE, MILESTONE_FIELD_NAME_REACHED_DATE]

    Default value: MILESTONE_FIELD_NAME_UNSPECIFIED

    queries object[]
  • Array [
    • isReachedQuery object
    reached boolean

    only reached milestones

  • ]
Responses

A successful response.

Schema
    details object
    totalResult uint64
    processedSequence uint64
    viewTimestamp date-time

    the last time the view got updated

    result object[]
  • Array [
    • type string

    Possible values: [MILESTONE_TYPE_UNSPECIFIED, MILESTONE_TYPE_INSTANCE_CREATED, MILESTONE_TYPE_AUTHENTICATION_SUCCEEDED_ON_INSTANCE, MILESTONE_TYPE_PROJECT_CREATED, MILESTONE_TYPE_APPLICATION_CREATED, MILESTONE_TYPE_AUTHENTICATION_SUCCEEDED_ON_APPLICATION, MILESTONE_TYPE_INSTANCE_DELETED]

    Default value: MILESTONE_TYPE_UNSPECIFIED

    reachedDate date-time
  • ]
POST /milestones/_search

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/admin/v1
Bearer Token
Content-Type
Body required
{

  "query": {

    "offset": "0",

    "limit": 100,

    "asc": true

  },

  "sortingColumn": "MILESTONE_FIELD_NAME_UNSPECIFIED",

  "queries": [

    {

      "isReachedQuery": {

        "reached": true

      }

    }

  ]

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/milestones/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "MILESTONE_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "isReachedQuery": {
        "reached": true
      }
    }
  ]
}'