Update Version - iTwin.js Extensions

iTwin.js Extensions

Download API definition:

Update Version

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

PATCH https://dev-api.bentley.com/extensions/{extensionId}/versions/{versionNumber}

Update metadata of the Extension Version.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request parameters

extensionId

Yes

Extension ID

versionNumber

Yes

Version number

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

UpdateVersionRequestBody

deprecated

Boolean, null

Indicated whether the Version is deprecated or not. If not provided, the value will not be changed. "Un-deprecating" a Version is not allowed.

Example

json

{
    "deprecated": true
}

Response 200 OK

Extension Version updated.

json

{
    "_links": {
        "self": {
            "href": "https://api.bentley.com/extensions/204baa23-d99e-427d-828f-425afe25b42d/versions/0.1.1"
        }
    },
    "version": {
        "number": "0.1.1",
        "deprecated": true,
        "creationTime": "2025-09-22T12:37:08.5Z",
        "lastUpdateTime": "2025-09-22T12:37:27.303Z"
    }
}

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

User is not authorized to update Extension Version.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

Requested resource is not available.

json

{
    "error": {
        "code": "VersionNotFound",
        "message": "Requested Version is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to update Extension Version.

json

{
    "error": {
        "code": "InvalidExtensionsRequest",
        "message": "Cannot update version.",
        "details": [{
            "code": "InvalidValue",
            "message": "Provided 'deprecated' is not valid. The value is not a boolean.",
            "target": "deprecated"
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

UpdateVersionRequestBody

deprecated

Boolean, null

Indicated whether the Version is deprecated or not. If not provided, the value will not be changed. "Un-deprecating" a Version is not allowed.

json

{
    "type": "object",
    "properties": {
        "deprecated": {
            "type": "boolean",
            "nullable": true,
            "description": "Indicated whether the Version is deprecated or not. If not provided, the value will not be changed. \"Un-deprecating\" a Version is not allowed."
        }
    }
}

UpdateVersionResponseBody

_links.self.href

String

version.number

String

version.deprecated

Boolean

version.creationTime

Date

version.lastUpdateTime

Date

json

{
    "type": "object",
    "properties": {
        "_links": {
            "type": "object",
            "properties": {
                "self": {
                    "type": "object",
                    "properties": {
                        "href": {
                            "type": "string"
                        }
                    },
                    "required": [
                        "href"
                    ]
                }
            },
            "required": [
                "self"
            ]
        },
        "version": {
            "type": "object",
            "properties": {
                "number": {
                    "type": "string"
                },
                "deprecated": {
                    "type": "boolean"
                },
                "creationTime": {
                    "type": "string",
                    "format": "Date"
                },
                "lastUpdateTime": {
                    "type": "string",
                    "format": "Date"
                }
            },
            "required": [
                "number",
                "deprecated",
                "creationTime",
                "lastUpdateTime"
            ]
        }
    },
    "required": [
        "_links",
        "version"
    ]
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

Detailed Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

Error Response

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?

Authentication

Request

Request parameters

Request headers

Request body

UpdateVersionRequestBody

Example

Response

Response 200 OK

Response 401 Unauthorized

Response 403 Forbidden

Response 404 Not Found

Response 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

UpdateVersionRequestBody

UpdateVersionResponseBody

DetailedError

Detailed Error Response

Error

Error Response