Search Milestones
POST/milestones/_search
Returns a list of reached instance usage milestones.
Request​
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
Possible values: [MILESTONE_FIELD_NAME_UNSPECIFIED
, MILESTONE_FIELD_NAME_TYPE
, MILESTONE_FIELD_NAME_REACHED_DATE
]
Default value: MILESTONE_FIELD_NAME_UNSPECIFIED
queries
object[]
isReachedQuery
object
only reached milestones
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
Possible values: [MILESTONE_FIELD_NAME_UNSPECIFIED
, MILESTONE_FIELD_NAME_TYPE
, MILESTONE_FIELD_NAME_REACHED_DATE
]
Default value: MILESTONE_FIELD_NAME_UNSPECIFIED
queries
object[]
isReachedQuery
object
only reached milestones
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
Possible values: [MILESTONE_FIELD_NAME_UNSPECIFIED
, MILESTONE_FIELD_NAME_TYPE
, MILESTONE_FIELD_NAME_REACHED_DATE
]
Default value: MILESTONE_FIELD_NAME_UNSPECIFIED
queries
object[]
isReachedQuery
object
only reached milestones
Responses​
- 200
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
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
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-12-06T11:34:51.033Z"
},
"result": [
{
"type": "MILESTONE_TYPE_UNSPECIFIED",
"reachedDate": "2024-12-06T11:34:51.033Z"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
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
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-12-06T11:34:51.033Z"
},
"result": [
{
"type": "MILESTONE_TYPE_UNSPECIFIED",
"reachedDate": "2024-12-06T11:34:51.033Z"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
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
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-12-06T11:34:51.033Z"
},
"result": [
{
"type": "MILESTONE_TYPE_UNSPECIFIED",
"reachedDate": "2024-12-06T11:34:51.033Z"
}
]
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}