Introduction

This endpoint is used to create, read, update, and delete records related to operating system wipe events. It does not perform any actual wipe operation. Instead, it serves as a logging and tracking mechanism to store details such as the device identifier, wipe timestamp, wipe method, operator, and status of the wipe.

Base URL: https://wipeos.unixsurplus.com

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

Endpoints

Save diagnostic data (machine, mobile, or disk).

Accepts diagnostic data and determines how to process it based on the data_type key. Supported types: machine, mobile, disk. If an unknown type is provided, the raw data will be saved unprocessed.

Example request:

curl --request POST \
    "https://wipeos.unixsurplus.com/api/diagnostic" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data_type\": \"machine\"
}"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/diagnostic"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "data_type": "machine"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Diagnostic saved successfully."
}

Example response (500):


{
    "message": "Diagnostic save unsuccessful."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/get

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/get" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/get"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "pagination": {
        "current_page": 1,
        "data": [
            {
                "id": "kRfO",
                "data_type": "machine",
                "purchase_order": null,
                "location": "659",
                "serial": "FN7RVP2",
                "model": "Latitude 7480",
                "tech": null,
                "notes": null,
                "result": "PASS",
                "created_at": "12/04/2025 9:31 PM"
            }
        ],
        "first_page_url": "https://wipeos.unixsurplus.com/api/get?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://wipeos.unixsurplus.com/api/get?page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "https://wipeos.unixsurplus.com/api/get?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://wipeos.unixsurplus.com/api/get",
        "per_page": 10,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    },
    "machineTotal": 1,
    "diskTotal": 0,
    "passTotal": 1,
    "failTotal": 0,
    "noResult": 0
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/disk-logs

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/disk-logs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/disk-logs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "pagination": {
        "current_page": 1,
        "data": [],
        "first_page_url": "https://wipeos.unixsurplus.com/api/disk-logs?page=1",
        "from": null,
        "last_page": 1,
        "last_page_url": "https://wipeos.unixsurplus.com/api/disk-logs?page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "https://wipeos.unixsurplus.com/api/disk-logs?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://wipeos.unixsurplus.com/api/disk-logs",
        "per_page": 10,
        "prev_page_url": null,
        "to": null,
        "total": 0
    },
    "diskTotal": 0,
    "passTotal": 0,
    "failTotal": 0,
    "noResult": 0
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/{key}/find/{id}

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/architecto/find/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/find/architecto"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unathorized Access."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/{key}/find/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

key string

Example: architecto

id string

The ID of the find. Example: architecto

GET api/{key}/{id}/components

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/architecto/architecto/components" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/architecto/components"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unathorized Access."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/{key}/{id}/components

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

key string

Example: architecto

id string

The ID of the {key}. Example: architecto

GET api/{key}/{id}/{component}/detail

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/architecto/architecto/architecto/detail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/architecto/architecto/detail"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unathorized Access."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/{key}/{id}/{component}/detail

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

key string

Example: architecto

id string

The ID of the {key}. Example: architecto

component string

Example: architecto

POST api/{key}/{id}/{component}/print

Example request:

curl --request POST \
    "https://wipeos.unixsurplus.com/api/architecto/architecto/architecto/print" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/architecto/architecto/print"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/{key}/{id}/{component}/print

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

key string

Example: architecto

id string

The ID of the {key}. Example: architecto

component string

Example: architecto

POST api/{key}/{id}/purchase_order

Example request:

curl --request POST \
    "https://wipeos.unixsurplus.com/api/architecto/architecto/purchase_order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/architecto/purchase_order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/{key}/{id}/purchase_order

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

key string

Example: architecto

id string

The ID of the {key}. Example: architecto

POST api/{key}/{id}/tech

Example request:

curl --request POST \
    "https://wipeos.unixsurplus.com/api/architecto/architecto/tech" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/architecto/tech"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/{key}/{id}/tech

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

key string

Example: architecto

id string

The ID of the {key}. Example: architecto

POST api/{key}/{id}/print

Example request:

curl --request POST \
    "https://wipeos.unixsurplus.com/api/architecto/architecto/print" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/architecto/print"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/{key}/{id}/print

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

key string

Example: architecto

id string

The ID of the {key}. Example: architecto

POST api/{key}/{id}/notes

Example request:

curl --request POST \
    "https://wipeos.unixsurplus.com/api/architecto/architecto/notes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/architecto/notes"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/{key}/{id}/notes

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

key string

Example: architecto

id string

The ID of the {key}. Example: architecto

POST api/{key}/generate-pdf/{id}

Example request:

curl --request POST \
    "https://wipeos.unixsurplus.com/api/architecto/generate-pdf/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/generate-pdf/architecto"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/{key}/generate-pdf/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

key string

Example: architecto

id string

The ID of the generate pdf. Example: architecto

GET api/purchase-orders

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/purchase-orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/purchase-orders"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin

[]

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/{key}/certificates

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/architecto/certificates" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/certificates"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Unathorized Access."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/{key}/erase-status

Example request:

curl --request POST \
    "https://wipeos.unixsurplus.com/api/architecto/erase-status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/architecto/erase-status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/test

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/test" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/test"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


[
    {
        "id": "kRfO",
        "data_type": "machine",
        "purchase_order": null,
        "location": "659",
        "serial": "FN7RVP2",
        "model": "Latitude 7480",
        "tech": null,
        "notes": null,
        "result": "PASS",
        "created_at": "12/04/2025 9:31 PM"
    }
]

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/test/get

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/test/get" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/test/get"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "message": "Server Error"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/store/{key}/check

Example request:

curl --request GET \
    --get "https://wipeos.unixsurplus.com/api/store/16/check" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://wipeos.unixsurplus.com/api/store/16/check"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
vary: Origin


{
    "exists": false
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Introduction

Authenticating requests

Endpoints

Save diagnostic data (machine, mobile, or disk).

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

GET api/get

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/disk-logs

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/{key}/find/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

GET api/{key}/{id}/components

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

GET api/{key}/{id}/{component}/detail

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/{key}/{id}/{component}/print

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/{key}/{id}/purchase_order

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/{key}/{id}/tech

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/{key}/{id}/print

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/{key}/{id}/notes

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/{key}/generate-pdf/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

GET api/purchase-orders

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/{key}/certificates

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

POST api/{key}/erase-status

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

GET api/test

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/test/get

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/store/{key}/check

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request