Update a specific Actions Module

Update properties of an existing Actions Module, such as code, dependencies, or secrets.

PATCH https://{tenantDomain}/api/v2/actions/modules/{id}

Update a specific Actions Module

cURL

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

import requests

url = "https://{tenantDomain}/api/v2/actions/modules/{id}"

payload = {
    "code": "<string>",
    "secrets": [
        {
            "name": "<string>",
            "value": "<string>"
        }
    ],
    "dependencies": [
        {
            "name": "<string>",
            "version": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    secrets: [{name: '<string>', value: '<string>'}],
    dependencies: [{name: '<string>', version: '<string>'}]
  })
};

fetch('https://{tenantDomain}/api/v2/actions/modules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/actions/modules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'secrets' => [
        [
                'name' => '<string>',
                'value' => '<string>'
        ]
    ],
    'dependencies' => [
        [
                'name' => '<string>',
                'version' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/actions/modules/{id}"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"secrets\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"dependencies\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/actions/modules/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"secrets\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"dependencies\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/actions/modules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"secrets\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"dependencies\": [\n    {\n      \"name\": \"<string>\",\n      \"version\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

The ID of the action module to update.

ボディ

application/jsonapplication/x-www-form-urlencoded

code · string

The source code of the action module.

Maximum string length: 65536

Pattern: ^[^]*$

secrets · object[]

The secrets to associate with the action module.

Show child attributes

dependencies · object[]

The npm dependencies of the action module.

Show child attributes

レスポンス

200

application/json

The action module was updated.

id · string

The unique ID of the module.

name · string

The name of the module.

code · string

The source code from the module's draft version.

dependencies · object[]

The npm dependencies from the module's draft version.

Show child attributes

secrets · object[]

The secrets from the module's draft version (names and timestamps only, values never returned).

Show child attributes

actions_using_module_total · integer

The number of deployed actions using this module.

all_changes_published · boolean

Whether all draft changes have been published as a version.

latest_version_number · integer

The version number of the latest published version. Omitted if no versions have been published.

created_at · string<date-time>

Timestamp when the module was created.

updated_at · string<date-time>

Timestamp when the module was last updated.

latest_version · object

The latest published version as a reference object. Omitted if no versions have been published.

Show child attributes