Roll back to a previous action version

Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.

POST https://{tenantDomain}/api/v2/actions/actions/{actionId}/versions/{id}/deploy

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Actions.Versions.DeployAsync(
            actionId: "actionId",
            id: "id",
            request: new DeployActionVersionRequestContent()
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v2/management"
    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.DeployActionVersionRequestBodyParams{}
    mgmt.Actions.Versions.Deploy(
        context.TODO(),
        "actionId",
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import java.util.Optional;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.actions().versions().deploy(
            "actionId",
            "id",
            Optional.empty()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Types\DeployActionVersionRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->actions->versions->deploy(
    'actionId',
    'id',
    new DeployActionVersionRequestContent([]),
);

from auth0.management import ManagementClient, DeployActionVersionRequestContent

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.actions.versions.deploy(
    action_id="actionId",
    id="id",
    request=DeployActionVersionRequestContent(),
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.actions.versions.deploy(
  action_id: "actionId",
  id: "id",
  request: {}
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.versions.deploy("actionId", "id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.versions.deploy("actionId", "id", {});
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/actions/actions/{actionId}/versions/{id}/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "update_draft": false
}
'

202

{
  "id": "12a3b9e6-06e6-4a29-96bf-90c82fe79a0d",
  "action_id": "910b1053-577f-4d81-a8c8-020e7319a38a",
  "code": "module.exports = () => {}",
  "dependencies": [
    {
      "name": "<string>",
      "version": "<string>",
      "registry_url": "<string>"
    }
  ],
  "deployed": true,
  "runtime": "node22",
  "secrets": [
    {
      "name": "mySecret",
      "updated_at": "2021-01-01T00:00:00.000Z"
    }
  ],
  "status": "built",
  "number": 1,
  "errors": [
    {
      "id": "<string>",
      "msg": "<string>",
      "url": "<string>"
    }
  ],
  "action": {
    "id": "910b1053-577f-4d81-a8c8-020e7319a38a",
    "name": "my-action",
    "supported_triggers": [
      {
        "version": "<string>",
        "status": "<string>",
        "runtimes": [
          "<string>"
        ],
        "default_runtime": "<string>",
        "compatible_triggers": [
          {
            "version": "<string>"
          }
        ]
      }
    ],
    "all_changes_deployed": false,
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-01-01T00:00:00.000Z"
  },
  "built_at": "2021-01-01T00:00:00.000Z",
  "created_at": "2021-01-01T00:00:00.000Z",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "supported_triggers": [
    {
      "version": "<string>",
      "status": "<string>",
      "runtimes": [
        "<string>"
      ],
      "default_runtime": "<string>",
      "compatible_triggers": [
        {
          "version": "<string>"
        }
      ]
    }
  ],
  "modules": [
    {
      "module_id": "<string>",
      "module_name": "<string>",
      "module_version_id": "<string>",
      "module_version_number": 123
    }
  ]
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

The ID of an action version.

actionId · string · required

The ID of an action.

Body

application/jsonapplication/x-www-form-urlencoded

update_draft · boolean · default: false

True if the draft of the action should be updated with the reverted version.

Response

202

application/json

Request to create action version was accepted.

id · string · default: 12a3b9e6-06e6-4a29-96bf-90c82fe79a0d

The unique id of an action version.

action_id · string · default: 910b1053-577f-4d81-a8c8-020e7319a38a

The id of the action to which this version belongs.

code · string · default: module.exports = () => {}

The source code of this specific version of the action.

dependencies · object[]

The list of third party npm modules, and their versions, that this specific version depends on.

Show child attributes

deployed · boolean · default: true

Indicates if this specific version is the currently one deployed.

runtime · string · default: node22

The Node runtime. For example: node22

secrets · object[]

The list of secrets that are included in an action or a version of an action.

Show child attributes

status · enum<string> · default: built

The build status of this specific version.

Available options: pending, building, packaged, built, retrying, failed

number · number · default: 1

The index of this version in list of versions for the action.

errors · object[]

Any errors that occurred while the version was being built.

Show child attributes

action · object

The action to which this version belongs.

Show child attributes

built_at · string<date-time> · default: 2021-01-01T00:00:00.000Z

The time when this version was built successfully.

created_at · string<date-time> · default: 2021-01-01T00:00:00.000Z

The time when this version was created.

updated_at · string<date-time> · default: 2021-01-01T00:00:00.000Z

The time when a version was updated. Versions are never updated externally. Only Auth0 will update an action version as it is being built.

supported_triggers · object[]

The list of triggers that this version supports. At this time, a version can only target a single trigger at a time.

Minimum array length: 1

Show child attributes

modules · object[]

The list of action modules and their versions used by this action version.

Show child attributes