Créer un module Action

Créez un nouveau module d’Actions pour réutiliser du code entre les Actions.

POST https://{tenantDomain}/api/v2/actions/modules

Créer un nouveau module d’Actions

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/actions/modules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "name": "<string>",
  "api_version": "<string>",
  "dependencies": [
    {
      "name": "<string>",
      "version": "<string>"
    }
  ],
  "publish": true,
  "secrets": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}
'

201

{
  "actions_using_module_total": 123,
  "all_changes_published": true,
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "dependencies": [
    {
      "name": "<string>",
      "version": "<string>"
    }
  ],
  "id": "<string>",
  "latest_version": {
    "code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "dependencies": [
      {
        "name": "<string>",
        "version": "<string>"
      }
    ],
    "id": "<string>",
    "secrets": [
      {
        "name": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "version_number": 123
  },
  "latest_version_number": 123,
  "name": "<string>",
  "secrets": [
    {
      "name": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corps

application/jsonapplication/x-www-form-urlencoded

code · string · requis

Le code source du module Action.

Maximum string length: 65536

Pattern: ^[^]*$

name · string · requis

Le nom du module Action.

Maximum string length: 255

Pattern: ^[^]*$

api_version · string

La version de l’API du module.

Maximum string length: 20

Pattern: ^[^]*$

dependencies · object[]

Les dépendances npm du module Action.

Show child attributes

publish · boolean

Indique s’il faut publier le module immédiatement après sa création.

secrets · object[]

Les secrets à associer au module Action.

Show child attributes

Réponse

201

application/json

Le module Action a été créé.

actions_using_module_total · integer

Le nombre d’Actions déployées qui utilisent ce module.

all_changes_published · boolean

Indique si toutes les modifications de la version provisoire ont été publiées en tant que version.

code · string

Le code source de la version provisoire du module.

created_at · string<date-time>

Horodatage de création du module.

dependencies · object[]

Les dépendances npm de la version provisoire du module.

Show child attributes

id · string

L’ID unique du module.

latest_version · object

La plus récente version publiée sous forme d’objet de référence. Omise si aucune version n’a été publiée.

Show child attributes

latest_version_number · integer

Le numéro de la plus récente version publiée. Omis si aucune version n’a été publiée.

name · string

Le nom du module.

secrets · object[]

Les secrets de la version provisoire du module (noms et horodatages seulement; les valeurs ne sont jamais renvoyées).

Show child attributes

updated_at · string<date-time>

Horodatage de la dernière mise à jour du module.