Spyctl

Diff spyderbat documents

This will diff one or more spyderbat documents with a primary document and return the diff output.

post/api/v1/org/{orgUID}/spyctl/diff/

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/spyctl/diff/
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Request body

content_typestring

The content type of the diff output. Possible values are: text, json.

full_diffboolean

When content_type is omitted or set to text this returns the full diff text instead of a summary.

include_irrelevantboolean

When set to true, the output of this API will return lists of objects, by kind, that had no impact on the diff. This option may increase compute time.

Response

OK

context_uidstring

Context UID for this query, it's used to track the query as it flows through the system

diff_datastring
irrelevantobject

Includes any objects that were irrelevant to the diff. The include_irrelevant option must be set to true to return this data.

Changes

No recorded changes to this operation across all 1 revision of this API.