Archivematica 1.13.0 is our latest release.

Storage Service API

The Storage Service API enables access to storage areas to which the Storage Service has access.

Resources and endpoints

Endpoints for the Storage Service API have been organized into the following resource categories:

Pipeline

A pipeline is a representation of an Archivematica installation that is assigned a unique universal identifier (UUID) when it is registered with the Storage Service. The UUID provides information about your server and all associated clients.

For each Storage Service API resource, you can display a detailed schema by adding “schema” to the get all URL like in the following example:

curl \
    --request GET \
    --header "Authorization: ApiKey test:95141fc645ed97a95893f1f865d24687f89a27ad" \
        'http://localhost:8000/api/v2/location/schema/?format=json

{
   "allowed_detail_http_methods": [
       "get",
       "post"
   ],
   "allowed_list_http_methods": [
       "get"
   ],
   "default_format": "application/json",
   "default_limit": 20,
   "fields": {
       "description": {
           "blank": false,
           "default": "No default provided.",
           "help_text": "Unicode string data. Ex: \"Hello World\"",
           "nullable": false,
           "primary_key": false,
           "readonly": true,
           "type": "string",
           "unique": false,
           "verbose_name": "description"
       },
       "enabled": {
           "blank": true,
           "default": true,
           "help_text": "True if space can be accessed.",
           "nullable": false,
           "primary_key": false,
           "readonly": false,
           "type": "boolean",
           "unique": false,
           "verbose_name": "Enabled"
       },
       "path": {
           "blank": false,
           "default": "No default provided.",
           "help_text": "Unicode string data. Ex: \"Hello World\"",
           "nullable": false,
           "primary_key": false,
           "readonly": true,
           "type": "string",
           "unique": false,
           "verbose_name": "path"
       },
       "pipeline": {
           "blank": false,
           "default": "No default provided.",
           "help_text": "Many related resources. Can be either a list of URIs
           or list of individually nested resource data.",
           "nullable": false,
           "primary_key": false,
           "readonly": false,
           "related_schema": "/api/v2/pipeline/schema/",
           "related_type": "to_many",
           "type": "related",
           "unique": false,
           "verbose_name": "pipeline"
       },
       "purpose": {
           "blank": false,
           "default": "No default provided.",
           "help_text": "Purpose of the space.  Eg. AIP storage, Transfer
           source",
           "nullable": false,
           "primary_key": false,
           "readonly": false,
           "type": "string",
           "unique": false,
           "verbose_name": "Purpose"
       },
       "quota": {
           "blank": false,
           "default": null,
           "help_text": "Size, in bytes (optional)",
           "nullable": true,
           "primary_key": false,
           "readonly": false,
           "type": "string",
           "unique": false,
           "verbose_name": "Quota"
       },
       "relative_path": {
           "blank": false,
           "default": "",
           "help_text": "Path to location, relative to the storage space's
           path.",
           "nullable": false,
           "primary_key": false,
           "readonly": false,
           "type": "string",
           "unique": false,
           "verbose_name": "Relative Path"
       },
       "resource_uri": {
           "blank": false,
           "default": "No default provided.",
           "help_text": "Unicode string data. Ex: \"Hello World\"",
           "nullable": false,
           "primary_key": false,
           "readonly": true,
           "type": "string",
           "unique": false,
           "verbose_name": "resource uri"
       },
       "space": {
           "blank": false,
           "default": "No default provided.",
           "help_text": "A single related resource. Can be either a URI or
           set of nested resource data.",
           "nullable": false,
           "primary_key": false,
           "readonly": false,
           "related_schema": "/api/v2/space/schema/",
           "related_type": "to_one",
           "type": "related",
           "unique": false,
           "verbose_name": "space"
       },
       "used": {
           "blank": false,
           "default": 0,
           "help_text": "Amount used, in bytes.",
           "nullable": false,
           "primary_key": false,
           "readonly": false,
           "type": "string",
           "unique": false,
           "verbose_name": "Used"
       },
       "uuid": {
           "blank": true,
           "default": "",
           "help_text": "Unique identifier",
           "nullable": false,
           "primary_key": false,
           "readonly": false,
           "type": "string",
           "unique": true,
           "verbose_name": "uuid"
       }
   },
   "filtering": {
       "pipeline": 2,
       "purpose": 1,
       "quota": 1,
       "relative_path": 1,
       "space": 2,
       "used": 1,
       "uuid": 1
   }
}

This schema, among other things, describes the fields in the resource (including the schema URI of related resource fields) and the fields that allow filtering. Valid filtering values are: Django ORM filters (e.g. startswith, exact, lte, etc.) or 1 or 2. If a filtering field is set to 2 it can be filtered over the related resource fields. For example, the locations could be filtered by their pipeline UUID setting it in a request parameter formatted with two underscore chars: /api/v2/location/?pipeline__uuid=<uuid>

For more info on how to interact with the API see:

Get all pipelines

GET /api/v2/pipeline/ Retrieves information about all pipelines in the system.

Query string parameters:

description Description of the pipeline.
uuid UUID associated with the pipeline.

Response definitions (JSON):

Returns information about all the pipelines in the system. Can be filtered by the description or uuid. Disabled pipelines are not returned.

meta Metadata on the response: number of hits, pagination information.
objects List of pipelines. See Get pipeline details for format.

Example request:

curl \
    --request GET \
    --header "Authorization: ApiKey test:95141fc645ed97a95893f1f865d24687f89a27ad"
        'http://localhost:8000/api/v2/pipeline/?description__startswith=Archivematica' \
            | python -m json.tool

Example response:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "description": "Archivematica on alouette",
            "remote_name": "127.0.0.1",
            "resource_uri": "/api/v2/pipeline/dd354557-9e6e-4918-9fe3-a65b00ecb1af/",
            "uuid": "dd354557-9e6e-4918-9fe3-a65b00ecb1af"
        }
    ]
}

Create new pipeline

POST /api/v2/pipeline/ Creates a new pipeline.

Request body parameters (accepts JSON strings as parameter values):

uuid UUID of the new pipeline.
description Pipeline description.
api_key API key associated with user for authorization.
api_username Username of admin authorized to write to the storage location.
create_default_locations If True, will associated default Locations with the newly created pipeline.
shared_path If default locations are created, create the processing location at this path in the local filesystem.
remote_name

URI of the pipeline.

Note: Before v0.11.0: If create_default_locations is set, SS will try to guess the value using the REMOTE_ADDR header.

In v0.11.0 or newer: If not provided, SS will try to guess the value using the REMOTE_ADDR header.

Example request:

curl \
    --request POST \
    --header "Authorization: ApiKey test:95141fc645ed97a95893f1f865d24687f89a27ad" \
    --headaer "Content-Type: application/json" \
    --data '{
      "uuid": "99354557-9e6e-4918-9fe3-a65b00ecb199", \
      "description": "Test pipeline", "create_default_locations": true, \
      "api_username": "demo", \
      "api_key": "03ecb307f5b8012f4771d245d534830378a87259" \
    }' \
        'http://192.168.1.42:8000/api/v2/pipeline/'

Example response:

{
   "create_default_locations": true,
   "description": "Test pipeline",
   "remote_name": "192.168.1.42",
   "resource_uri": "/api/v2/pipeline/99354557-9e6e-4918-9fe3-a65b00ecb199/",
   "uuid": "99354557-9e6e-4918-9fe3-a65b00ecb199"
}

Get pipeline details

GET /api/v2/pipeline/<uuid> Retrieves information about all pipelines in the system.

Response definitions (JSON):

description General statement about the pipeline.
remote_name IP or hostname of the pipeline for use in API calls.
resource_uri URI for this pipeline in the API.
uuid UUID of the pipeline.

Example request:

curl --location --request GET 'http://test-machine.archivematica.net:8000/
api/v2/pipeline/?uuid=a64e061a-5688-49b5-95c1-0b6885c40c04' \
--header 'Authorization: ApiKey test-user:ow7ioGh2reephua8uPaiWee6EiHeev9u' \
--header 'Cookie: csrftoken=sb52U8S35EpdB2T1K4lWXFl5jNnOrXrA'

Example response (JSON body):

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "description": "Archivematica on Test-machine",
            "remote_name": "127.0.0.1",
            "resource_uri": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "uuid": "a64e061a-5688-49b5-95c1-0b6885c40c04"
        }
    ]
}

Space

A storage space contains all the information necessary to connect to the physical storage. It is where the files are stored. Protocol-specific information, like an NFS export path and hostname, or the username of a system accessible only via SSH, is stored here. All locations must be contained in a space.

Get all spaces

GET /api/v2/space/ Retrieves information about all the spaces in the system. Can be filtered by several fields: access protocol, path, size, amount used, UUID and verified status. Disabled spaces are not returned.

Query string parameters:

access_protocol Protocol that the space uses; must be searched based on the database code.
path Space’s path.
size Maximum size in bytes. Can use greater than (size__gt=1024), less than (size__lt=1024), and other Django field lookups.
used Bytes stored in this space. Can use greater than (size__gt=1024), less than (size__lt=1024), and other Django field lookups.
uuid UUID of the space.

Response definitions (JSON):

meta Metadata on the response: number of hits, pagination information.
objects List of spaces.

Example request:

curl --location --request GET 'http://test-machine.archivematica.net:8000/
api/v2/space/' \
--header 'Authorization: ApiKey test-user:ow7ioGh2reephua8uPaiWee6EiHeev9u' \
--header 'Cookie: csrftoken=sb52U8S35EpdB2T1K4lWXFl5jNnOrXrA'

Example response (JSON):

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "access_protocol": "FS",
            "id": 1,
            "last_verified": null,
            "path": "/",
            "resource_uri": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
            "size": null,
            "space": "218caeb7-fd59-4b7b-99b1-f5771a2dd34f",
            "used": "186549173",
            "uuid": "218caeb7-fd59-4b7b-99b1-f5771a2dd34f",
            "verified": false
        }
    ]
}

Get space details

GET /api/v2/space/<UUID>/ Returns space-specific details.

Response definitions (JSON):

access_protocol Database code for the access protocol.
last verified Date of last verification; this is a stub feature.
path Space’s path.
resource_uri URI to the resource in the API.
size Maximum size of the space in bytes.
used Bytes stored in this space.
uuid UUID of the space.
verified If the space is verified, this is a stub feature.

Example request:

curl --location --request GET 'http://test-machine.archivematica.net:8000/
api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/' \
--header 'Authorization: ApiKey test-user:ow7ioGh2reephua8uPaiWee6EiHeev9u' \
--header 'Cookie: csrftoken=sb52U8S35EpdB2T1K4lWXFl5jNnOrXrA'

Example response (JSON):

{
    "access_protocol": "FS",
    "id": 1,
    "last_verified": null,
    "path": "/",
    "resource_uri": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
    "size": null,
    "space": "218caeb7-fd59-4b7b-99b1-f5771a2dd34f",
    "used": "186549173",
    "uuid": "218caeb7-fd59-4b7b-99b1-f5771a2dd34f",
    "verified": false
}

Browse space path

GET /api/v2/space/<UUID>/browse/ Gets details about the space path and directory structure.

Query string parameters:

path Path inside the Space to look.

Response definitions (JSON):

entries List of entries at path, files or directories.
directories List of directories in path. Subset of entries.

Example request:

curl --location --request GET 'http://test-machine.archivematica.net:8000/
api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/' \
--header 'Authorization: ApiKey test-user:ow7ioGh2reephua8uPaiWee6EiHeev9u' \
--header 'Cookie: csrftoken=sb52U8S35EpdB2T1K4lWXFl5jNnOrXrA'

Example response (JSON):

{
    "access_protocol": "FS",
    "id": 1,
    "last_verified": null,
    "path": "/",
    "resource_uri": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
    "size": null,
    "space": "218caeb7-fd59-4b7b-99b1-f5771a2dd34f",
    "used": "186549173",
    "uuid": "218caeb7-fd59-4b7b-99b1-f5771a2dd34f",
    "verified": false
}

Create space

Note

For background, see Issue 36

POST /api/v2/pipeline/space Creates a new space.

Request body parameters:

Parameters should contain fields for a new space: See the Storage Service documentation or Space for fields relevant to each type of space. Basic fields for a local file system space are listed below.

access_protocol This defines the type of space.
path Absolute path to the space on the local filesystem.
size (Optional) Maximum size allowed for this space. Set to 0 or leave blank for unlimited.

Example (to create an S3 space):

curl \
    --request POST \
    --data @payload.json \
    --header "Content-Type: application/json" \
    --header "Authorization: ApiKey test:test" \
        http://127.0.0.1:62081/api/v2/space/

Where payload.json contains:

{
  "access_protocol": "S3",
  "path": "",
  "staging_path": "/",
  "endpoint_url": "http://127.0.0.1:12345",
  "access_key_id": "_Cah4cae1_",
  "secret_access_key": "_Thu6Ahqu_",
  "region": "us-west-2"
}

Note

Endpoint returns all paths base64 encoded.

Location

A location is a subdivision of a space. Each location is assigned a specific purpose, such as AIP storage, DIP storage, transfer source or transfer backlog, in order to provide an organized way to structure content within a space.

Get all locations

GET /api/v2/location/ Returns space-specific details.

Example request:

curl \
    --request GET \
    --header "Authorization: ApiKey test:95141fc645ed97a95893f1f865d24687f89a27ad" \
        'http://localhost:8000/api/v2/location/schema/?format=json'

Example response:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 7
    },
    "objects": [
        {
            "description": "",
            "enabled": true,
            "path": "/home",
            "pipeline": [
                "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/"
            ],
            "purpose": "TS",
            "quota": null,
            "relative_path": "home",
            "resource_uri": "/api/v2/location/a48e2a56-bae7-4b63-824e-b886bbadd77d/",
            "space": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
            "used": "0",
            "uuid": "a48e2a56-bae7-4b63-824e-b886bbadd77d"
        },
        {
            "description": "Store AIP in standard Archivematica Directory",
            "enabled": true,
            "path": "/var/archivematica/sharedDirectory/www/AIPsStore",
            "pipeline": [
                "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/"
            ],
            "purpose": "AS",
            "quota": null,
            "relative_path": "var/archivematica/sharedDirectory/www/AIPsStore",
            "resource_uri": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
            "space": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
            "used": "179586607",
            "uuid": "6286affb-6a2b-4ac7-b81e-192d84ede4c6"
        },
        {
            "description": "Store DIP in standard Archivematica Directory",
            "enabled": true,
            "path": "/var/archivematica/sharedDirectory/www/DIPsStore",
            "pipeline": [
                "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/"
            ],
            "purpose": "DS",
            "quota": null,
            "relative_path": "var/archivematica/sharedDirectory/www/DIPsStore",
            "resource_uri": "/api/v2/location/8b70e21b-57a3-46f1-baee-c8c48fb6383c/",
            "space": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
            "used": "6773558",
            "uuid": "8b70e21b-57a3-46f1-baee-c8c48fb6383c"
        },
        {
            "description": "Default transfer backlog",
            "enabled": true,
            "path": "/var/archivematica/sharedDirectory/www/AIPsStore/transferBacklog",
            "pipeline": [
                "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/"
            ],
            "purpose": "BL",
            "quota": null,
            "relative_path": "var/archivematica/sharedDirectory/www/AIPsStore/\
            transferBacklog",
            "resource_uri": "/api/v2/location/0da78c11-4ea7-4c52-8114-d39980e5\
            ad2b/",
            "space": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
            "used": "189008",
            "uuid": "0da78c11-4ea7-4c52-8114-d39980e5ad2b"
        },
        {
            "description": "For storage service internal usage.",
            "enabled": true,
            "path": "/var/archivematica/storage_service",
            "pipeline": [],
            "purpose": "SS",
            "quota": null,
            "relative_path": "var/archivematica/storage_service",
            "resource_uri": "/api/v2/location/5bf813d0-5663-4025-aac3-956ed1403790/",
            "space": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
            "used": "0",
            "uuid": "5bf813d0-5663-4025-aac3-956ed1403790"
        },
        {
            "description": "Default AIP recovery",
            "enabled": true,
            "path": "/var/archivematica/storage_service/recover",
            "pipeline": [
                "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/"
            ],
            "purpose": "AR",
            "quota": null,
            "relative_path": "var/archivematica/storage_service/recover",
            "resource_uri": "/api/v2/location/e26a003e-361c-45ad-b82e-185faabc\
            7a2d/",
            "space": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
            "used": "0",
            "uuid": "e26a003e-361c-45ad-b82e-185faabc7a2d"
        },
        {
            "description": null,
            "enabled": true,
            "path": "/var/archivematica/sharedDirectory",
            "pipeline": [
                "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/"
            ],
            "purpose": "CP",
            "quota": null,
            "relative_path": "var/archivematica/sharedDirectory/",
            "resource_uri": "/api/v2/location/6f99d6c7-65ff-4966-993d-92a40df4\
            a072/",
            "space": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
            "used": "0",
            "uuid": "6f99d6c7-65ff-4966-993d-92a40df4a072"
        }
    ]
}

Create new location

POST /api/v2/location/

Added in v0.12 - see issue `367 <https://github.com/artefactual/archivematica-storage-service/issues/367>`_ and issue `37 <https://github.com/archivematica/Issues/issues/37>`_.

This endpoint creates a location in the storage service, but it doesn’t actually create the directory to which the location points.

Request body parameters:

description Information about the space.
pipeline URI of the pipeline.
space URI of the space.
default If ‘true’ this location will be the default for it’s purpose.
purpose

Accepts the following possible values:

AR (AIP_RECOVERY)

AS (AIP_STORAGE)

CP (CURRENTLY_PROCESSING)

DS (DIP_STORAGE)

SD (SWORD_DEPOSIT)

SS (STORAGE_SERVICE_INTERNAL)

BL (BACKLOG)

TS (TRANSFER_SOURCE)

RP (REPLICATOR)

relative_path Relative to the space’s path.

Example:

curl \
  --request POST \
  --silent \
  --header "Authorization: ApiKey test:test" \
  --header "Content-Type: application/json" \
  --data '{
      "pipeline": ["/api/v2/pipeline/90707555-244f-47af-8271-66496a6a965b/"],
      "purpose": "TS",
      "relative_path": "foo/bar",
      "description": "foobar",
      "space": "/api/v2/space/141593ff-2a27-44a1-9de1-917573fa0f4a/"
    }' \
      "http://127.0.0.1:62081/api/v2/location/"

Get location details

GET /api/v2/location/<UUID>/ Returns space-specific details.

Example request:

curl \
    --request GET \
    --header 'Authorization: ApiKey test_user:ow7ioGh2reephua8uPaiWee3EiHeev6u' \
        'http://test.archivematica.net:8000/api/v2/location/e26a003e-361c-45ad-b82e-185faabc7a4d'

Example response:

{
    "description": "Default AIP recovery",
    "enabled": true,
    "path": "/var/archivematica/storage_service/recover",
    "pipeline": [
        "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/"
    ],
    "purpose": "AR",
    "quota": null,
    "relative_path": "var/archivematica/storage_service/recover",
    "resource_uri": "/api/v2/location/e26a003e-361c-45ad-b82e-185faabc7a4d/",
    "space": "/api/v2/space/218caeb7-fd59-4b7b-99b1-f5771a2dd34f/",
    "used": "0",
    "uuid": "e26a003e-361c-45ad-b82e-185faabc7a2d"
}

Move files to this location

POST /api/v2/location/<UUID>/ Move files to specified pipe- line location.

Request body parameters:

origin_location UUID of the pipeline on which to reingest AIP.
pipeline URI of the pipeline. Both Locations must be associated with this pipeline.
files List of dicts containing source and destination. The source and destination are paths relative to their Location of the files to be moved.

Note

Intended for use with creating Transfers, SIPs, etc and other cases where files need to be moved but not tracked by the storage service.

Browse location path

GET /api/v2/location/<UUID>/browse/ Returns location paths that are base64 encoded.

Query string parameters:

entries List of entries in path, files or directories.
directories List of directories in path. Subset of entries.

SWORD collection

GET, POST /api/v2/location/<UUID>/ sword/collection Part of the Archivematica storage service REST API. The Storage Service also talks to the Archivematica dashboard, however, to notify it that a transfer created from a SWORD deposit has been approved for processing.

The Archivematica Sword API enables 3rd party applications to automate the process of creating Transfers.

1. Create Transfer - set the name and other metadata about a Transfer Populate Transfer - add/edit/update digital objects in a Transfer, and associated metadata.

2. Finalize Transfer - indicates that the Transfer is ready to start processing. After content has been deposited, if users have access to the deposit directory they can also manually manipulate the deposit directory aside from any manipulation using the API.

3. Once a Transfer has been created, populated and finalized, Archivematica will begin processing that Transfer.

Example request:

curl \
    --location \
    --request GET \
        'http://test.archivematica.net:8000/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede7c6/browse/'

Example response:

{
    "directories": [
        "MTk5OA==",
        "MjdkOQ==",
        "MmM0Yg==",
        "MmNkMA==",
        "OTE0NA==",
        "YjdlZg==",
        "ZTA1Mg==",
        "dHJhbnNmZXJCYWNrbG9n"
    ],
    "entries": [
        "MTk5OA==",
        "MjdkOQ==",
        "MmM0Yg==",
        "MmNkMA==",
        "OTE0NA==",
        "YjdlZg==",
        "ZTA1Mg==",
        "dHJhbnNmZXJCYWNrbG9n"
    ],
    "properties": {
        "MTk5OA==": {
            "object count": 1
        },
        "MjdkOQ==": {
            "object count": 1
        },
        "MmM0Yg==": {
            "object count": 1
        },
        "MmNkMA==": {
            "object count": 1
        },
        "OTE0NA==": {
            "object count": 1
        },
        "YjdlZg==": {
            "object count": 1
        },
        "ZTA1Mg==": {
            "object count": 1
        },
        "dHJhbnNmZXJCYWNrbG9n": {
            "object count": 34
        }
    }
}

Package

A package is a bundle of one or more files transferred from an external service; for example, a package may be an AIP, a backlogged transfer, or a DIP. Each package is stored in a location.

Get all packages

GET /api/v2/file/ Retrieves information about all packages for all available storage locations.

Example request:

curl \
    --location \
    --request GET \
    --header 'Authorization: ApiKey test_user:ow7ioGh2reephua8uPaiWee3EiHeev6u' \
        'http://test.archivematica.net:8000/api/v2/file/'

Example response:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 11
    },
    "objects": [
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/27d9/8723/a8f2/490b/9116/88c5/a555/9ca2/img-2-27d98723-a8f2-490b-9116-88c5a5559ca2.7z",
            "current_location": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
            "current_path": "27d9/8723/a8f2/490b/9116/88c5/a555/9ca2/img-2-27d98723-a8f2-490b-9116-88c5a5559ca2.7z",
            "encrypted": false,
            "misc_attributes": {
                "reingest_pipeline": null
            },
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "AIP",
            "related_packages": [],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/27d98723-a8f2-490b-9116-88c5a5559ca2/",
            "size": 11444115,
            "status": "UPLOADED",
            "uuid": "27d98723-a8f2-490b-9116-88c5a5559ca2"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/b7ef/c3ad/81dc/4581/b630/f7ed/5ca8/01ce/images-b7efc3ad-81dc-4581-b630-f7ed5ca801ce.7z",
            "current_location": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
            "current_path": "b7ef/c3ad/81dc/4581/b630/f7ed/5ca8/01ce/images-b7efc3ad-81dc-4581-b630-f7ed5ca801ce.7z",
            "encrypted": false,
            "misc_attributes": {
                "reingest_pipeline": null
            },
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "AIP",
            "related_packages": [],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/b7efc3ad-81dc-4581-b630-f7ed5ca801ce/",
            "size": 11447220,
            "status": "UPLOADED",
            "uuid": "b7efc3ad-81dc-4581-b630-f7ed5ca801ce"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/9144/66c1/d89d/4232/b583/7dcd/631f/d08a/test-914466c1-d89d-4232-b583-7dcd631fd08a.7z",
            "current_location": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
            "current_path": "9144/66c1/d89d/4232/b583/7dcd/631f/d08a/test-914466c1-d89d-4232-b583-7dcd631fd08a.7z",
            "encrypted": false,
            "misc_attributes": {},
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "AIP",
            "related_packages": [],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/914466c1-d89d-4232-b583-7dcd631fd08a/",
            "size": 43609598,
            "status": "UPLOADED",
            "uuid": "914466c1-d89d-4232-b583-7dcd631fd08a"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/1998/acb4/c6d8/439f/8e74/7285/ba15/012d/i2-1998acb4-c6d8-439f-8e74-7285ba15012d.7z",
            "current_location": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
            "current_path": "1998/acb4/c6d8/439f/8e74/7285/ba15/012d/i2-1998acb4-c6d8-439f-8e74-7285ba15012d.7z",
            "encrypted": false,
            "misc_attributes": {
                "reingest_pipeline": null
            },
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "AIP",
            "related_packages": [],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/1998acb4-c6d8-439f-8e74-7285ba15012d/",
            "size": 11408327,
            "status": "UPLOADED",
            "uuid": "1998acb4-c6d8-439f-8e74-7285ba15012d"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/2cd0/575f/5e0b/4d2f/bd00/7e0b/254e/0802/mc-test-2cd0575f-5e0b-4d2f-bd00-7e0b254e0802.7z",
            "current_location": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
            "current_path": "2cd0/575f/5e0b/4d2f/bd00/7e0b/254e/0802/mc-test-2cd0575f-5e0b-4d2f-bd00-7e0b254e0802.7z",
            "encrypted": false,
            "misc_attributes": {},
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "AIP",
            "related_packages": [
                "/api/v2/file/855e14e9-2921-4b51-be77-0afdbdc16aeb/"
            ],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/2cd0575f-5e0b-4d2f-bd00-7e0b254e0802/",
            "size": 11416388,
            "status": "UPLOADED",
            "uuid": "2cd0575f-5e0b-4d2f-bd00-7e0b254e0802"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/DIPsStore/855e/14e9/2921/4b51/be77/0afd/bdc1/6aeb/mc-test-2cd0575f-5e0b-4d2f-bd00-7e0b254e0802",
            "current_location": "/api/v2/location/8b70e21b-57a3-46f1-baee-c8c48fb6383c/",
            "current_path": "855e/14e9/2921/4b51/be77/0afd/bdc1/6aeb/mc-test-2cd0575f-5e0b-4d2f-bd00-7e0b254e0802",
            "encrypted": false,
            "misc_attributes": {},
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "DIP",
            "related_packages": [
                "/api/v2/file/2cd0575f-5e0b-4d2f-bd00-7e0b254e0802/"
            ],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/855e14e9-2921-4b51-be77-0afdbdc16aeb/",
            "size": 3386601,
            "status": "UPLOADED",
            "uuid": "855e14e9-2921-4b51-be77-0afdbdc16aeb"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/transferBacklog/originals/test_bag-cdc18f4b-e859-4244-9c42-c575b69e92fe",
            "current_location": "/api/v2/location/0da78c11-4ea7-4c52-8114-d39980e5ad2b/",
            "current_path": "originals/test_bag-cdc18f4b-e859-4244-9c42-c575b69e92fe",
            "encrypted": false,
            "misc_attributes": {},
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "transfer",
            "related_packages": [],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/cdc18f4b-e859-4244-9c42-c575b69e92fe/",
            "size": 189008,
            "status": "UPLOADED",
            "uuid": "cdc18f4b-e859-4244-9c42-c575b69e92fe"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/e052/5606/c710/4380/9c98/fdb4/3e77/c0ba/demo_images-e0525606-c710-4380-9c98-fdb43e77c0ba.7z",
            "current_location": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
            "current_path": "e052/5606/c710/4380/9c98/fdb4/3e77/c0ba/demo_images-e0525606-c710-4380-9c98-fdb43e77c0ba.7z",
            "encrypted": false,
            "misc_attributes": {},
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "AIP",
            "related_packages": [
                "/api/v2/file/578fec0b-4d6e-4725-8649-e03be6ab7425/"
            ],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/e0525606-c710-4380-9c98-fdb43e77c0ba/",
            "size": 11414225,
            "status": "UPLOADED",
            "uuid": "e0525606-c710-4380-9c98-fdb43e77c0ba"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/DIPsStore/578f/ec0b/4d6e/4725/8649/e03b/e6ab/7425/demo_images-e0525606-c710-4380-9c98-fdb43e77c0ba",
            "current_location": "/api/v2/location/8b70e21b-57a3-46f1-baee-c8c48fb6383c/",
            "current_path": "578f/ec0b/4d6e/4725/8649/e03b/e6ab/7425/demo_images-e0525606-c710-4380-9c98-fdb43e77c0ba",
            "encrypted": false,
            "misc_attributes": {},
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "DIP",
            "related_packages": [
                "/api/v2/file/e0525606-c710-4380-9c98-fdb43e77c0ba/"
            ],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/578fec0b-4d6e-4725-8649-e03be6ab7425/",
            "size": 3386957,
            "status": "UPLOADED",
            "uuid": "578fec0b-4d6e-4725-8649-e03be6ab7425"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/2c4b/a224/5889/4a07/a6ca/8323/5ad1/82e0/metadata-2c4ba224-5889-4a07-a6ca-83235ad182e0.7z",
            "current_location": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
            "current_path": "2c4b/a224/5889/4a07/a6ca/8323/5ad1/82e0/metadata-2c4ba224-5889-4a07-a6ca-83235ad182e0.7z",
            "encrypted": false,
            "misc_attributes": {},
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "AIP",
            "related_packages": [],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/2c4ba224-5889-4a07-a6ca-83235ad182e0/",
            "size": 78948258,
            "status": "UPLOADED",
            "uuid": "2c4ba224-5889-4a07-a6ca-83235ad182e0"
        },
        {
            "current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/9390/594f/84c2/457d/bd6a/618f/21f7/c954/cf-1-9390594f-84c2-457d-bd6a-618f21f7c954.7z",
            "current_location": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
            "current_path": "9390/594f/84c2/457d/bd6a/618f/21f7/c954/cf-1-9390594f-84c2-457d-bd6a-618f21f7c954.7z",
            "encrypted": false,
            "misc_attributes": {},
            "origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
            "package_type": "AIP",
            "related_packages": [],
            "replicas": [],
            "replicated_package": null,
            "resource_uri": "/api/v2/file/9390594f-84c2-457d-bd6a-618f21f7c954/",
            "size": 11417385,
            "status": "UPLOADED",
            "uuid": "9390594f-84c2-457d-bd6a-618f21f7c954"
        }
    ]
}

Create new package

POST /api/v2/file/

Creates a database entry tracking the package (AIP, transfer, etc). If the package is an AIP, DIP or AIC and the current_location is an AIP or DIP storage location it also moves the files from the source to destination location. If the package is a Transfer and the current_location is transfer backlog, it is also moved.

This is handled through the modified obj_create function, which calls Package.store_aip or Package.backlog_transfer.

Query string parameters:

uuid UUID of the new package.
origin_location URI of the Location where the package is currently.
origin_path Path to the package, relative to the origin_location.
current_location URI of the Location where the package should be stored.
current_path Path where the package should be stored, relative to the current_location.
package_type Type of package this is. One of: AIP, AIC, DIP, transfer, SIP, file, deposit.
size Size of the package.
origin_pipeline URI of the pipeline the package is from.
related_package_uuid UUID of a package that is related to this one. E.g. UUID of a DIP when storing an AIP

Get package details

GET /api/v2/file/<UUID> Retrieves information about a package.

Example request:

curl \
    --location
    --request GET \
    --header 'Authorization: ApiKey test:ow7ioGh2reephua8uPaiWee4EiHeav7u' \
        'http://test.archivematica.net:8000/api/v2/file/9390594f-84c2-457d-bd6a-618f21f7c954/'

Example response:

{
"current_full_path": "/var/archivematica/sharedDirectory/www/AIPsStore/9390/594f/84c2/457d/bd6a/618f/21f7/c954/cf-1-9390594f-84c2-457d-bd6a-618f21f7c954.7z",
"current_location": "/api/v2/location/6286affb-6a2b-4ac7-b81e-192d84ede4c6/",
"current_path": "9390/594f/84c2/457d/bd6a/618f/21f7/c954/cf-1-9390594f-84c2-457d-bd6a-618f21f7c954.7z",
"encrypted": false,
"misc_attributes": {},
"origin_pipeline": "/api/v2/pipeline/a64e061a-5688-49b5-95c1-0b6885c40c04/",
"package_type": "AIP",
"related_packages": [],
"replicas": [],
"replicated_package": null,
"resource_uri": "/api/v2/file/9390594f-84c2-457d-bd6a-618f21f7c954/",
"size": 11417385,
"status": "UPLOADED",
"uuid": "9390594f-84c2-457d-bd6a-618f21f7c954"
}

Update package contents

PUT /api/v2/file/<UUID>

Updates the contents of a package during reingest. If the package is an AIP or AIC, currently stored in an AIP storage location, and the ‘reingest’ parameter is set, it will call Package.finish_reingest and merge the new AIP with the existing one.

This is implemented using a modified obj_update which calls obj_update_hook.

Request body parameters:

reingest Flag to mark that this is reingest. Reduces chance to accidentally modify an AIP.
uuid UUID of the existing package.
origin_location URI of the Location where the package is currently.
origin_path Path to the package, relative to the origin_location.
current_location URI of the Location where the package should be stored
package_type Type of package this is. One of: AIP, AIC.
size Size of the package.
origin_pipeline URI of the pipeline the package is from. This must be the same pipeline reingest was started on (tracked through Package.misc_attributes.reingest_pipeline).

Update package metadata

PATCH /api/v2/file/<UUID> Updates the metadata stored in the database for the package. Currently, this is used to update the reingest status.

Note

Currently, this always sets Package.misc_attributes.reingest to None, regardless of what value was actually passed in.

This is implemented using a modified obj_update which calls obj_update_hook. update_in_place also helps.

Delete package request

POST /api/v2/file/<UUID>/delete_aip/ Requests package deletion.

Request body parameters (mandatory):

event_reason Rationale for deleting the AIP.
pipeline UUID of the pipeline the delete request is from.
user_id User ID requesting the deletion. This is the ID of the user on the pipeline, and must be an integer greater than 0.
user_email Email of the user requesting the deletion.

Example request:

curl \
    --location \
    --request POST \
    --header 'Authorization: ApiKey test:ow7ioGh2reephua8uPaiWee4EiHeev2z' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "event_reason": "testing purposes",
    "pipeline": "a64e061a-5688-49b5-95c1-0b6885c40c04",
    "user_id": "1",
    "user_email": "demo@example.com"
    }' \
        'http://test.archivematica.net:8000/api/v2/file/2cd0575f-5e0b-4d2f-bd00-7e0b254e0802/delete_aip/'

Example response:

{
    "message": "Delete request created successfully.",
    "id": 3
}

Recover AIP request

POST /api/v2/file/<UUID>/recover_aip/ Requests package recovery.

Request body parameters (mandatory):

event_reason Rationale for recovering the AIP.
pipeline URI of the pipeline the recovery request is from.
user_id User ID requesting the recovery. This is the ID of the user on the pipeline, and must be an integer greater than 0.
user_email Email of the user requesting the recovery.

Example request:

curl \
    --location \
    --request POST
    --header 'Authorization: ApiKey test:ow7ioGh2reephua8uPaiWee4EiHeev2z' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "event_reason": "testing purposes",
    "pipeline": "a64e061a-5688-49b5-95c1-0b6885c40c04",
    "user_id": "1",
    "user_email": "demo@example.com"
    }' \
        'http://test.archivematica.net:8000/api/v2/file/2cd0575f-5e0b-4d2f-bd00-7e0b254e0802/recover_aip/'

Example response:

{
    "message": "Recover request created successfully.",
    "id": 4
}

Download single file

GET, HEAD /api/v2/file/<UUID>/extract_file/ Checks if a package is locally available and returns a single file from the package.

Note

(Future improvement) HEAD and GET should not perform the same functions. HEAD should be updated to not return the file, and to only check for existence. Currently, the storage service has no way to check if a file exists except by downloading and extracting this AIP.

Response:

Returns a single file from the Package. If the package is compressed, it downloads the whole AIP and extracts it.

This responds to HEAD because AtoM uses HEAD to check for the existence of a file.

If the package is in Arkivum, the package may not actually be available. This endpoint checks if the package is locally available. If it is, it is returned as normal. If not, it returns 202 and emails the administrator about the attempted access.

Download package

GET, HEAD

/api/v2/file/<UUID>/download/

/api/v2/file/<UUID>/download/ <chunk number>/ (for LOCKSS harvesting)

Checks if a package is available and returns the entire package as a single file.

If the package is in Arkivum, the package may not actually be available. This endpoint checks if the package is locally available. If it is, it is returned as normal. If not, it returns 202 and emails the administrator about the attempted access.

Get pointer file

GET /api/v2/file/<UUID>/pointer_file/ Checks if a pointer file is available and returns the contents of the pointer file.

Check fixity

GET //api/v2/file/<UUID>/check_fixity/ Performs a bag check and updates the Storage Service database with the results of that check.

Query string parameters:

force_local If true, download and run fixity on the AIP locally, instead of using the Space-provided fixity if available.

Response definitions (JSON):

success True if the verification succeeded, False if the verification failed, None if the scan could not start.
message Human-readable string explaining the report; it will be empty for successful scans.
failures List of 0 or more errors.
timestamp ISO-formated string with the datetime of the last fixity check. If the check was performed by an external system, this will be provided by that system. If not provided,or on error, it will be None.

AIP storage callback request

GET /api/v2/file/<UUID>/send_callback/post_store/ Gets callbacks configured to run post-storage for given AIP.

Tip

In the Archivematica Storage Service versions 0.15 and above, this endpoint has been extended to support callbacks for AIP, AIC and DIP stored events.

Note

When using this endpoint, AIPs must be locally stored for the API call to work properly currently.

Get file information for package

GET /api/v2/file/<UUID>/contents/ Retrieves metadata on every file within a package.

Response definitions (JSON):

success True.
package UUID of the package.
files

List of dictionaries with file information. Each dictionary has:

  • source_id - UUID of the file to index.
  • name - relative path of the file inside the package.
  • source_package - UUID of the SIP this file is from.
  • checksum - checksum of the file, or an empty string.
  • accessionid - Accession number, or an empty string.
  • origin - UUID of the Archivematica dashboard this is from.

Update file information for package

PUT /api/v2/file/<UUID>/contents/ Adds a set of files to a package.

Response definitions (JSON):

relative_path Relative path of the file inside the package.
fileuuid UUID of the file to index.
accessionid Accession number, or an empty string.
sipuuid UUID of the SIP this file is from.
origin UUID of the Archivematica dashboard this is from.

Delete file information for package

DELETE /api/v2/file/<UUID>/contents/ Removes all file records associated with this package.

Query file information on packages

GET, POST /api/v2/file/metadata/ Access or write file information about the files.

Response definitions (JSON):

file

List of dictionaries with information about files that match the query:

  • accessionid - accession number, or an empty string.
  • file_extension - file extension.
  • filename - name of the file, sans path.
  • relative_path - relative path of the file inside the package.
  • fileuuid - UUID of the file to index.
  • sipuuid - UUID of the SIP this file is from.
  • origin - UUID of the Archivematica dashboard this is from.

Reingest AIP

POST /api/v2/file/<UUID>/reingest/ Initiates an AIP reingest.

Example request:

curl -X POST \
  http://127.0.0.1:8000/api/v2/file/868a7ecd-c31b-4773-ad6d-d736a35b8a6e/
  reingest/ \
  -H 'Authorization: ApiKey analyst:ow7ioGh2reephua8uPaiWee4EiHeev6u' \
  -H 'Content-Type: application/json' \
  -H 'Host: 127.0.0.1:8000' \
  -d '{
    "pipeline":"85f9db99-b187-47c3-9b5b-fa35470104c4",
    "reingest_type":"FULL"
    }'

Request body parameters (JSON):

pipeline UUID of the pipeline on which to reingest AIP.
reingest_type One of METADATA_ONLY (metadata-only reingest), OBJECTS (partial reingest), FULL (full reingest).
processing_config Optional. Name of the processing configuration to use on full reingest.

Example response:

{
    "error": false,
    "message": "Package 868a7ecd-c31b-4773-ad6d-d736a35b8a6e sent to pipeline 
    Archivematica on test-vm (85f9db99-b187-47c3-9b5b-abc123) 
    for re-ingest",
    "reingest_uuid": "affa2d71-3fdb-423f-8fe2-91c8d5ecc324",
    "status_code": 202
}

Move package

Note

This endpoint was introduced in the Storage Service version 0.14.

POST /api/v2/file/<UUID>/move/ Relocates a package.

Request body parameters (JSON):

location_uuid UUID of the location to send the package. The location must have the same Purpose as the package’s current location (e.g. AIP Storage, DIP Storage).

Example request:

curl \
    -d 'location_uuid=7c5c48d4-50db-4018-b4b1-7ed29d1ef9d3 ' \
    --header "Authorization: ApiKey test:4525fd5272275caeac04a28447698c51" \
        'http://mysite.archivematica.org:8000/api/v2/file/8b8aa1a2-79c9-490e-b630-28f90bb7e654/move/'

SWORD endpoints

  • URL: /api/v2/file/<UUID>/sword/
  • URL: /api/v2/file/<UUID>/sword/media/
  • URL: /api/v2/file/<UUID>/sword/state/

Archivematica 1.13.0

License

Archivematica documentation by Artefactual Systems Inc. is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Creative Commons License