Skip to main content
POST
List changes

Restrictions

Usage

  • start_time and end_time are both required: start_time must be less than end_time, and the window can span at most 31 days.
  • A change matches when its [start_time, last_time] range overlaps the query window.
  • Set include_events to true to attach each change’s underlying events in events.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
start_time
integer<int64>
required

Start of the query window, Unix seconds. Required in practice: it must be less than end_time, and the window can span at most 31 days. A change matches when its [start_time, last_time] range overlaps the window.

Required range: x >= 0
end_time
integer<int64>
required

End of the query window, Unix seconds. Required in practice; see start_time.

Required range: x >= 0
p
integer<int64>
default:1

Page number, starting at 1. Defaults to 1.

Required range: x >= 1
limit
integer<int64>
default:10

Number of items per page, 1-100. Defaults to 10.

Required range: 1 <= x <= 100
channel_ids
integer<int64>[]

Filter by channel IDs.

Channel ID.

integration_ids
integer<int64>[]

Filter by reporting integration IDs. At least 1 entry when provided.

Minimum array length: 1

Integration ID.

orderby
enum<string>

Sort field: start_time or last_time. Defaults to start_time.

Available options:
start_time,
last_time
asc
boolean

Sort in ascending order when true; default is descending.

include_events
boolean

Include the underlying change events for each change when true.

query
string

Case-insensitive substring or regular-expression match over the change title, change_key, and description. An invalid regular expression falls back to a literal match.

filters
object[]

Structured filters ANDed onto the query (e.g. on labels). Keys prefixed with incident are ignored. Supported keys are labels.<name>, title, description, change_key, change_status and link; keys are not validated, so any other key matches nothing under IN and everything under NOTIN. oper is case-insensitive and a condition with empty vals is dropped.

data_source_ids
integer<int64>[]
deprecated

Deprecated: use integration_ids instead. At least 1 entry when provided.

Minimum array length: 1

Integration ID.

data_source_id
integer<int64>
deprecated

Deprecated: use integration_ids instead. Single integration ID to filter by.

Required range: x >= 1
integration_id
integer<int64>
deprecated

Deprecated: use integration_ids instead. Single integration ID to filter by.

Required range: x >= 1

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.