Contract signatures

Download schema

Methods to manage contract signatures.

List contract signatures for an Organization

GET

https://api.scaleway.com

/account/v3/contract-signatures

List contract signatures for an Organization › query Parameters

organization_id

string · required

Filter on Organization ID. (UUID format)

page

integer · int32

The page number for the returned contracts.

page_size

integer · uint32

The maximum number of contracts per page.

order_by

string · enum

How the contracts are ordered in the response.

Enum values:

signed_at_asc

signed_at_desc

expires_at_asc

expires_at_desc

name_asc

name_desc

Default: signed_at_asc

List contract signatures for an Organization › Responses

200

scaleway.account.v3.ListContractSignaturesResponse

total_count

integer · uint64

The total number of contract signatures.

scaleway.account.v3.ContractSignature[]

The paginated returned contract signatures.

GET/account/v3/contract-signatures

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/account/v3/contract-signatures?organization_id=6170692e-7363-616c-6577-61792e636f6d"

Example Responses

{
  "total_count": 0,
  "contract_signatures": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "signed_at": "2022-03-22T12:34:56.123456Z",
      "expires_at": "2022-03-22T12:34:56.123456Z",
      "contract": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "type": "unknown_type",
        "name": "name",
        "version": 0,
        "created_at": "2022-03-22T12:34:56.123456Z",
        "updated_at": "2022-03-22T12:34:56.123456Z"
      }
    }
  ]
}

json

application/json

Create a signature for your Organization for the latest version of the requested contract

POST

https://api.scaleway.com

/account/v3/contract-signatures

Create a signature for your Organization for the latest version of the requested contract › Request Body

contract_type

string · enum

The type of the contract.

Enum values:

unknown_type

global

k8s

instance

container

baremetal

network

core

Default: unknown_type

contract_name

string

The name of the contract.

validated

boolean

Whether the contract is validated at creation.

organization_id

string

ID of the Organization. (UUID format)

Create a signature for your Organization for the latest version of the requested contract › Responses

200

scaleway.account.v3.ContractSignature

id

string

ID of the contract signature. (UUID format)

organization_id

string

The Organization ID which signed the contract. (UUID format)

created_at

string · date-time

The creation date of the contract signature. (RFC 3339 format)

signed_at

string · date-time

The signing date of the contract signature. (RFC 3339 format)

expires_at

string · date-time

The expiration date of the contract signature. (RFC 3339 format)

object

The contract signed.

POST/account/v3/contract-signatures

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contract_name": "string",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "validated": false
  }' \
  "https://api.scaleway.com/account/v3/contract-signatures"

Example Request Body

{
  "contract_type": "unknown_type",
  "contract_name": "contract_name",
  "validated": true,
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "signed_at": "2022-03-22T12:34:56.123456Z",
  "expires_at": "2022-03-22T12:34:56.123456Z",
  "contract": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "type": "unknown_type",
    "name": "name",
    "version": 0,
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  }
}

json

application/json

Download a contract content

GET

https://api.scaleway.com

/account/v3/contract-signatures/{contract_signature_id}/download

Download a contract content › path Parameters

contract_signature_id

string · required

The contract signature ID. (UUID format)

Download a contract content › query Parameters

locale

string · enum

The locale requested for the content of the contract.

Enum values:

unknown_language_code

en_US

fr_FR

de_DE

Default: unknown_language_code

Download a contract content › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Sign a contract for your Organization

POST

https://api.scaleway.com

/account/v3/contract-signatures/{contract_signature_id}/validate

Sign a contract for your Organization › path Parameters

contract_signature_id

string · required

The contract linked to your Organization you want to sign. (UUID format)

Sign a contract for your Organization › Request Body

Sign a contract for your Organization › Responses

200

scaleway.account.v3.ContractSignature

id

string

ID of the contract signature. (UUID format)

organization_id

string

The Organization ID which signed the contract. (UUID format)

created_at

string · date-time

The creation date of the contract signature. (RFC 3339 format)

signed_at

string · date-time

The signing date of the contract signature. (RFC 3339 format)

expires_at

string · date-time

The expiration date of the contract signature. (RFC 3339 format)

object

The contract signed.

POST/account/v3/contract-signatures/{contract_signature_id}/validate

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/account/v3/contract-signatures/{contract_signature_id}/validate"

Example Request Body

{}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "signed_at": "2022-03-22T12:34:56.123456Z",
  "expires_at": "2022-03-22T12:34:56.123456Z",
  "contract": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "type": "unknown_type",
    "name": "name",
    "version": 0,
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z"
  }
}

json

application/json

Check if a contract is signed for your Organization

POST

https://api.scaleway.com

/account/v3/contract-signatures/check

Check if a contract is signed for your Organization › Request Body

organization_id

string

ID of the Organization to check the contract signature for. (UUID format)

contract_type

string · enum

Filter on contract type.

Enum values:

unknown_type

global

k8s

instance

container

baremetal

network

core

Default: unknown_type

contract_name

string

Filter on contract name.

Check if a contract is signed for your Organization › Responses

200

scaleway.account.v3.CheckContractSignatureResponse

created

boolean

Whether a signature has been requested for this contract.

validated

boolean

Whether the signature for this contract has been validated.

List contract signatures for an Organization

GET

https://api.scaleway.com

/account/v3/contract-signatures

List contract signatures for an Organization › query Parameters

organization_id

string · required

Filter on Organization ID. (UUID format)

page

integer · int32

The page number for the returned contracts.

page_size

integer · uint32

The maximum number of contracts per page.

order_by

string · enum

How the contracts are ordered in the response.

Enum values:

signed_at_asc

signed_at_desc

expires_at_asc

expires_at_desc

name_asc

name_desc

Default: signed_at_asc

List contract signatures for an Organization › Responses

200

scaleway.account.v3.ListContractSignaturesResponse

total_count

integer · uint64

The total number of contract signatures.

scaleway.account.v3.ContractSignature[]

The paginated returned contract signatures.

Create a signature for your Organization for the latest version of the requested contract

POST

https://api.scaleway.com

/account/v3/contract-signatures

Create a signature for your Organization for the latest version of the requested contract › Request Body

contract_type

string · enum

The type of the contract.

Enum values:

unknown_type

global

k8s

instance

container

baremetal

network

core

Default: unknown_type

contract_name

string

The name of the contract.

validated

boolean

Whether the contract is validated at creation.

organization_id

string

ID of the Organization. (UUID format)

Create a signature for your Organization for the latest version of the requested contract › Responses

200

scaleway.account.v3.ContractSignature

id

string

ID of the contract signature. (UUID format)

organization_id

string

The Organization ID which signed the contract. (UUID format)

created_at

string · date-time

The creation date of the contract signature. (RFC 3339 format)

signed_at

string · date-time

The signing date of the contract signature. (RFC 3339 format)

expires_at

string · date-time

The expiration date of the contract signature. (RFC 3339 format)

object

The contract signed.

Download a contract content

GET

https://api.scaleway.com

/account/v3/contract-signatures/{contract_signature_id}/download

Download a contract content › path Parameters

contract_signature_id

string · required

The contract signature ID. (UUID format)

Download a contract content › query Parameters

locale

string · enum

The locale requested for the content of the contract.

Enum values:

unknown_language_code

en_US

fr_FR

de_DE

Default: unknown_language_code

Download a contract content › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Sign a contract for your Organization

POST

https://api.scaleway.com

/account/v3/contract-signatures/{contract_signature_id}/validate

Sign a contract for your Organization › path Parameters

contract_signature_id

string · required

The contract linked to your Organization you want to sign. (UUID format)

Sign a contract for your Organization › Request Body

Sign a contract for your Organization › Responses

200

scaleway.account.v3.ContractSignature

id

string

ID of the contract signature. (UUID format)

organization_id

string

The Organization ID which signed the contract. (UUID format)

created_at

string · date-time

The creation date of the contract signature. (RFC 3339 format)

signed_at

string · date-time

The signing date of the contract signature. (RFC 3339 format)

expires_at

string · date-time

The expiration date of the contract signature. (RFC 3339 format)

object

The contract signed.

Check if a contract is signed for your Organization

POST

https://api.scaleway.com

/account/v3/contract-signatures/check

Check if a contract is signed for your Organization › Request Body

organization_id

string

ID of the Organization to check the contract signature for. (UUID format)

contract_type

string · enum

Filter on contract type.

Enum values:

unknown_type

global

k8s

instance

container

baremetal

network

core

Default: unknown_type

contract_name

string

Filter on contract name.

Check if a contract is signed for your Organization › Responses

200

scaleway.account.v3.CheckContractSignatureResponse

created

boolean

Whether a signature has been requested for this contract.

validated

boolean

Whether the signature for this contract has been validated.