Sign in
Application

Update an application

Updates information for an application.

put/application/{id}

Path parameters

idinteger required

The ID of the application.

Request body

namestring

The application name.

ℹ️ Note: Changing the application's name does not change the slug, as doing so could break connections with existing applications and services.

status'pending' | 'creating' | 'updating' | 'active' | 'inactive' | 'failed' | 'deleting'

The status of the application.

repository_urlstring

The URL of the repository that holds this application.

template_idinteger

The ID of the template used to create this application.

ℹ️ Note: If you patch the template, make sure that the new template is compatible with the repository URL, especially if it includes rules.

Example request

{
  "name": "Billing API",
  "status": "active",
  "repository_url": "https://github.com/crypto-inc/accounting-billing-api",
  "template_id": 3456,
  "tags": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "settings": {
    "defaults": {
      "branch": "main",
      "environment": "staging"
    },
    "asset": {
      "docker_server": {
        "uri": "registry.example.com/acme-corp/billing-api"
      },
      "ecr": {
        "uri": "123456789012.dkr.ecr.us-east-1.amazonaws.com/billing-api",
        "arn": "arn:aws:ecr:us-east-1:123456789012:repository/billing-api"
      }
    },
    "code_repository": {
      "specification_id": "7f3c910e-8138-4d65-9d09-b97d89f2c509",
      "specification_slug": "github-configuration",
      "specification_name": "GitHub",
      "specification_icon": "github",
      "provider_id": "82eee42c-46c9-4bb7-a53d-c08b027817f3"
    }
  }
}

Response

The operation was successful.

idinteger required

A system-wide unique ID for the application.

nrnstring

The NRN (Nullplatform Resource Name) uniquely identifying this application in the nullplatform hierarchy.

namestring required

The application name.

slugstring required

A namespace-wide unique slug for the application.

namespace_idinteger required

The ID of the namespace that owns this application.

status'pending' | 'creating' | 'updating' | 'active' | 'inactive' | 'failed' | 'deleting' required

The status of the application.

repository_urlstring required

The URL of the repository that holds this application.

repository_app_pathstring nullable

The folder where the application is located inside a monorepo.

is_mono_repoboolean required

True if the application shares the repository with other apps, false otherwise.

auto_deploy_on_creationboolean required

True if the application must be deployed immediately after being created, false otherwise.

template_idinteger required

The ID of the template used to create this application.

Example response

{
  "id": 1234,
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "name": "Billing API",
  "slug": "billing-api",
  "namespace_id": 2345,
  "status": "active",
  "repository_url": "https://github.com/crypto-inc/accounting-billing-api",
  "template_id": 3456,
  "metadata": {
    "key": "value"
  },
  "settings": {
    "defaults": {
      "branch": "main",
      "environment": "staging"
    },
    "asset": {
      "docker_server": {
        "uri": "registry.example.com/acme-corp/billing-api"
      },
      "ecr": {
        "uri": "123456789012.dkr.ecr.us-east-1.amazonaws.com/billing-api",
        "arn": "arn:aws:ecr:us-east-1:123456789012:repository/billing-api"
      }
    },
    "code_repository": {
      "specification_id": "7f3c910e-8138-4d65-9d09-b97d89f2c509",
      "specification_slug": "github-configuration",
      "specification_name": "GitHub",
      "specification_icon": "github",
      "provider_id": "82eee42c-46c9-4bb7-a53d-c08b027817f3"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.