POST /elements/{elementId}/archive

Archive Element (Asset)

Archives a specific Element (Asset) identified by its ID.

Operation ID: archiveElement

lock This endpoint requires a Bearer token in the Authorization header.

Path Parameters

Name	Type	Description
`elementId` required path	string	Element ID

Request Body

Content-Type: application/json

Responses

status string

Indicates the outcome of the operation. Always 'success' for this response type.

Example: success

data string | null

Placeholder for response data, which is intentionally null for this operation's successful outcome.

status string

error

error object

properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer

400

message string

Example: Property validation error.

more_info string

status string

error

error object

http_code integer

401

message string

Example: Authentication token invalid.

more_info string

status string

error

error object

http_code integer

403

message string

Example: Action unauthorized

more_info string

status string

error

error object

http_code integer

404

message string

Example: Resource not found

more_info string | null

status string

error

error object

http_code integer

409

message string

Example: Data constraint violations or concurrent modification exceptions

more_info string

status string

error

error object

http_code integer

429

message string

Example: Too Many Requests.

more_info string

status string

error

error object

http_code integer

500

message string

Example: An error has occurred during the request.

more_info string

play_circle Try It

Environment

Authorization

Bearer

Path Parameters

elementId

Request Body

POST https://api.sandbox.infraspeak.com/v3/elements/{elementId}/archive

curl -X POST \
  'https://api.sandbox.infraspeak.com/v3/elements/{elementId}/archive' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -d '[]'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/elements/{elementId}/archive', {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
  body: JSON.stringify([]),
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->post('https://api.sandbox.infraspeak.com/v3/elements/{elementId}/archive',
    array (
    )
  );

import requests

response = requests.post(
    'https://api.sandbox.infraspeak.com/v3/elements/{elementId}/archive',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
    json={
        []
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "status": "success",
    "data": "string"
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "string"
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

403 Forbidden. The action can not be fulfilled.

{
    "status": "error",
    "error": {
        "http_code": 403,
        "message": "Action unauthorized",
        "more_info": "string"
    }
}

404 Resource Not Found. Requests to resources that don't exist or are malformed.

{
    "status": "error",
    "error": {
        "http_code": 404,
        "message": "Resource not found",
        "more_info": "string"
    }
}

409 Server conflicts. Data constraint violations or concurrent modification exceptions occurred.

{
    "status": "error",
    "error": {
        "http_code": 409,
        "message": "Data constraint violations or concurrent modification exceptions",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}