The YAML diff and the template diff between two versions of a profile.

GET

/profiles/{key}/diff

curl --request GET \
  --url 'https://example.com/api/v1/profiles/example/diff?from_version=1&to_version=1'

Parameters

Path Parameters

key

required

string

Query Parameters

from_version

required

integer

to_version

required

integer

Responses

200

The diff.

Media typeapplication/json

object

from

required

integer

to

required

integer

yaml

required

Array<object>

object

op

required

string

Allowed values: equal insert delete

text

required

One or more whole lines, each ending with a newline except possibly the last line of the file.

string

template

required

Array<object>

object

op

required

string

Allowed values: equal insert delete

text

required

One or more whole lines, each ending with a newline except possibly the last line of the file.

string

Example

{
  "yaml": [
    {
      "op": "equal"
    }
  ],
  "template": [
    {
      "op": "equal"
    }
  ]
}

default

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

instance

string

code

required

A stable machine-readable error code.

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}