GET

/#Action=DeregisterType

http://cloudformation.{region}.amazonaws.com/#Action=DeregisterType

Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations. To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry. You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated. To view the deprecation status of an extension or extension version, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.

Access Token Required: API Key

Query Params

Arnstring

The Amazon Resource Name (ARN) of the extension. Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.

Typestring

The kind of extension. Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.

Allowed:

TypeNamestring

The name of the extension. Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.

VersionIdstring

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://cloudformation.{region}.amazonaws.com/#Action=DeregisterType' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}