Search Milestones

POST 
/milestones/_search

Returns a list of reached instance usage milestones.

Request

application/json

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 (string)

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

]

application/grpc

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 (string)

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

]

application/grpc-web+proto

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 (string)

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

200

A successful response.

application/json

Schema

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

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-12-20T16:04:50.136Z"
  },
  "result": [
    {
      "type": "MILESTONE_TYPE_UNSPECIFIED",
      "reachedDate": "2024-12-20T16:04:50.136Z"
    }
  ]
}

application/grpc

Schema

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

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-12-20T16:04:50.137Z"
  },
  "result": [
    {
      "type": "MILESTONE_TYPE_UNSPECIFIED",
      "reachedDate": "2024-12-20T16:04:50.137Z"
    }
  ]
}

application/grpc-web+proto

Schema

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

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-12-20T16:04:50.137Z"
  },
  "result": [
    {
      "type": "MILESTONE_TYPE_UNSPECIFIED",
      "reachedDate": "2024-12-20T16:04:50.137Z"
    }
  ]
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...