Get the agreement

Current runtime and map pack agreement (CLI credential, maps:read)

GET /api/v1/distribution/license

Get the agreement

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/distribution/license \
  --header 'Authorization: Bearer <token>'

200

{
  "schema": "simforge.distribution-agreement/v1",
  "status": "available",
  "reason": "no_current_agreement",
  "agreement": {
    "version": "<string>",
    "title": "<string>",
    "text": "<string>",
    "sha256": "<string>",
    "draft": true,
    "audience": "staff",
    "approvedBy": "<string>",
    "approvedAt": "<string>",
    "publishedAt": "<string>"
  },
  "acceptance": {
    "agreementVersion": "<string>",
    "agreementSha256": "<string>",
    "acceptedAt": "<string>"
  }
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Response

200

application/json

The current agreement, or why none is available.

schema · enum<string> · required

Available options: simforge.distribution-agreement/v1

status · enum<string> · required

Available options: available, unavailable

reason · enum<string> | null · required

Available options: no_current_agreement, agreement_not_approved, null

agreement · object | null · required

Show child attributes

acceptance · object | null · required

Show child attributes