Download OpenAPI specification:
Each resource can be accessed or modified using specially formed URLs and the standard HTTP methods:
GET to read
POST to create
PUT to update
DELETE to remove
We require that all requests are done over SSL. The API supports JSON formats. Rucio uses OAuth to authenticate all API requests. The method is to get an authentication token, and use it for the rest of the requests. Descriptions of the actions you may perform on each resource can be found below.
All dates returned are in UTC and are strings in the following format (RFC 1123, ex RFC 822):
Mon, 13 May 2013 10:23:03 UTC
In code format, which can be used in all programming languages that support strftime or strptime:
%a, %d %b %Y %H:%M:%S UTC
We require that all requests(except for the ping) are done over SSL.
The currently-available response format for all REST endpoints is the string-based format JavaScript Object Notation(JSON). The server answer can be one of the following content-type in the http Header:
Content-type: application/json
Content-Type: application/x-json-stream
In the last case, it corresponds to JSON objects delimited by newlines(streaming JSON for large answer), e.g.:
{ "id": 1, "foo": "bar" } { "id": 2, "foo": "baz" } ...
Errors are returned using standard HTTP error code syntax. Any additional info is included in the header of the return call, JSON-formatted with the parameters:
ExceptionClass ExceptionMessage
Where ExceptionClass refers to Rucio Exceptions
.
account required | string The account for the accountlimit. |
rse required | string The rse for the accountlimit. |
curl --request DELETE \ --url http://undefinedundefined/accountlimits/local/{account}/{rse} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
account required | string The account for the accountlimit. |
rse required | string The rse for the accountlimit. |
bytes required | integer The new limit in bytes. |
{- "bytes": 0
}
"Created"
account required | string The account for the accountlimit. |
rse_expression required | string The rse expression for the accountlimit. |
curl --request DELETE \ --url http://undefinedundefined/accountlimits/global/{account}/{rse_expression} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
account required | string The account for the accountlimit. |
rse_expression required | string The rse expression for the accountlimit. |
bytes required | integer The new limit in bytes. |
{- "bytes": 0
}
"Created"
Delete an attribute of an account.
account required | string The account identifier. |
key required | string The key of the account attribute to remove. |
curl --request DELETE \ --url http://undefinedundefined/accounts/{account}/attr/{key} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Create an attribute to an account.
account required | string The account identifier. |
key required | string The key of the account attribute. |
key | string The key of the attribute. This would override the key defined in path. |
value required | string The value of the attribute. |
{- "key": "string",
- "value": "string"
}
"Created"
Creates a scopse with the given name for an account.
account required | string The account identifier. |
scope required | string The scope name. |
curl --request POST \ --url http://undefinedundefined/accounts/{account}/scopes/{scope} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
"Created"
Get the current local limits for an account on a specific RSE.
account required | string The account identifier. |
rse required | string The rse identifier. |
curl --request GET \ --url http://undefinedundefined/accounts/{account}/limits/local/{rse} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
{ }
Get the current global limits for an account on a specific RSE expression.
account required | string The account identifier. |
rse_expression required | string The rse identifier. |
curl --request GET \ --url http://undefinedundefined/accounts/{account}/limits/global/{rse_expression} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
{ }
Lists all identities for an account.
account required | string The account identifier. |
curl --request GET \ --url http://undefinedundefined/accounts/{account}/identities \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- [
- "string",
- "string"
]
]
Delete an account identity.
account required | string The account identifier. |
identity required | string The identity. |
authtype required | string The authtype. |
{- "identity": "string",
- "authtype": "string"
}
Grant an account identity access to an account.
account required | string The account identifier. |
identity required | string The identity. |
authtype required | string The authtype. |
email required | string The email. |
password | string Default: "none" The password. |
default | string Default: false Should this be the default account? |
{- "identity": "string",
- "authtype": "string",
- "email": "string",
- "password": "none",
- "default": false
}
"Created"
Lists all rules for an account.
account required | string The account identifier. |
curl --request GET \ --url http://undefinedundefined/accounts/{account}/rules \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- "string"
]
Returns the account usage history.
account required | string The account identifier. |
rse required | string The rse identifier. |
curl --request GET \ --url http://undefinedundefined/accounts/{account}/usage/history/{rse} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "bytes": 0,
- "files": "string",
- "updated_at": "string"
}
]
Returns the local account usage.
account required | string The account identifier. |
rse required | string The rse identifier. |
curl --request GET \ --url http://undefinedundefined/accounts/{account}/usage/local/{rse} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "rse_id": "string",
- "bytes": 0,
- "bytes_limit": 0,
- "bytes_remaining": 0
}
]
Returns the local account usage.
account required | string The account identifier. |
rse_expression required | string The rse expression. |
curl --request GET \ --url http://undefinedundefined/accounts/{account}/usage/global/{rse_expression} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "rse_expression": "string",
- "bytes": 0,
- "bytes_limit": 0,
- "bytes_remaining": 0
}
]
Lists all parameters for an account.
account required | string The account identifier. |
curl --request GET \ --url http://undefinedundefined/accounts/{account} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
{- "account": "string",
- "account_type": "string",
- "status": "string",
- "email": "string",
- "suspended_at": "string",
- "deleted_at": "string"
}
Create an account.
account required | string The account identifier. |
type required | string Enum: "USER" "GROUP" "SERVICE" The account type. |
email required | string The email for the account. |
{- "type": "USER",
- "email": "string"
}
"Created"
Update a parameter for an account.
account required | string The account identifier. |
Json object with key-value pairs corresponding to the new values of the parameters.
{ }
curl --request GET \ --url http://undefinedundefined/accounts \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "account": "string",
- "type": "string",
- "email": "string"
}
]
Authenticate a Rucio account temporarily via username and password.
X-Rucio-Account required | string Account identifier as a string. |
X-Rucio-Username required | string Username as a string. |
X-Rucio-Password required | string password as a text-plain string. |
X-Rucio-AppID | string Application identifier as a string. |
X-Forwarded-For | string The forward ip address. |
curl --request GET \ --url http://undefinedundefined/auth/userpass \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Account: SOME_STRING_VALUE' \ --header 'X-Rucio-AppID: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' \ --header 'X-Rucio-Password: SOME_STRING_VALUE' \ --header 'X-Rucio-Username: SOME_STRING_VALUE'
Authenticate a Rucio account via GSS.
X-Rucio-Account required | string |
REMOTE_USER required | string |
X-Rucio-AppID | string |
X-Forwarded-For | string |
curl --request GET \ --url http://undefinedundefined/auth/gss \ --header 'REMOTE_USER: SOME_STRING_VALUE' \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Account: SOME_STRING_VALUE' \ --header 'X-Rucio-AppID: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Authenticate a Rucio account via x509.
X-Rucio-Account required | string |
X-Rucio-AppID | string |
X-Forwarded-For | string |
X-Rucio-Allow-Return-Multiple-Accounts | boolean If set to true, a HTTP 206 response will be returned if the identity is associated with multiple accounts. |
curl --request GET \ --url http://undefinedundefined/auth/x509 \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Account: SOME_STRING_VALUE' \ --header 'X-Rucio-Allow-Return-Multiple-Accounts: SOME_BOOLEAN_VALUE' \ --header 'X-Rucio-AppID: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Authenticate a Rucio account via SSH.
X-Rucio-Account required | string |
X-Rucio-SSH-Signature required | string |
X-Rucio-AppID | string |
X-Forwarded-For | string |
curl --request GET \ --url http://undefinedundefined/auth/ssh \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Account: SOME_STRING_VALUE' \ --header 'X-Rucio-AppID: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' \ --header 'X-Rucio-SSH-Signature: SOME_STRING_VALUE'
Authenticate a Rucio account via SSHChallengeToken.
X-Rucio-Account required | string |
X-Rucio-AppID | string |
X-Forwarded-For | string |
curl --request GET \ --url http://undefinedundefined/auth/ssh_challenge_token \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Account: SOME_STRING_VALUE' \ --header 'X-Rucio-AppID: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
SSHChallengeToken Allow cross-site scripting. Explicit for Authentication.
curl --request OPTIONS \ --url http://undefinedundefined/auth/ssh_challenge_token \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Authenticate a Rucio account via SAML.
X-Rucio-Account required | string |
X-Rucio-AppID | string |
X-Forwarded-For | string |
curl --request GET \ --url http://undefinedundefined/auth/saml \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Account: SOME_STRING_VALUE' \ --header 'X-Rucio-AppID: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Validate a Rucio auth token.
X-Rucio-Account required | string |
curl --request GET \ --url http://undefinedundefined/auth/validate \ --header 'X-Rucio-Account: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Authenticate a Rucio account via OIDC.
HTTP_X_RUCIO_ACCOUNT | string Account identifier as a string. |
HTTP_X_RUCIO_CLIENT_AUTHORIZE_SCOPE | string |
HTTP_X_RUCIO_CLIENT_AUTHORIZE_AUDIENCE | string |
HTTP_X_RUCIO_CLIENT_AUTHORIZE_AUTO | string |
HTTP_X_RUCIO_CLIENT_AUTHORIZE_ISSUER | string |
HTTP_X_RUCIO_CLIENT_AUTHORIZE_POLLING | string |
HTTP_X_RUCIO_CLIENT_AUTHORIZE_REFRESH_LIFETIME | string |
X-Forwarded-For | string |
curl --request GET \ --url http://undefinedundefined/auth/oidc \ --header 'HTTP_X_RUCIO_ACCOUNT: SOME_STRING_VALUE' \ --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_AUDIENCE: SOME_STRING_VALUE' \ --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_AUTO: SOME_STRING_VALUE' \ --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_ISSUER: SOME_STRING_VALUE' \ --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_POLLING: SOME_STRING_VALUE' \ --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_REFRESH_LIFETIME: SOME_STRING_VALUE' \ --header 'HTTP_X_RUCIO_CLIENT_AUTHORIZE_SCOPE: SOME_STRING_VALUE' \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Authenticate a Rucio account via TokenOIDC.
X-Forwarded-For | string |
curl --request GET \ --url http://undefinedundefined/auth/oidc_token \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Authenticate a Rucio account via CodeOIDC.
X-Forwarded-For | string |
curl --request GET \ --url http://undefinedundefined/auth/oidc_code \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Authenticate a Rucio account via RedirectOIDC.
X-Rucio-Client-Fetch-Token | string |
curl --request GET \ --url http://undefinedundefined/auth/oidc_redirect \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' \ --header 'X-Rucio-Client-Fetch-Token: SOME_STRING_VALUE'
RedirectOIDC Allow cross-site scripting. Explicit for Authentication.
curl --request OPTIONS \ --url http://undefinedundefined/auth/oidc_redirect \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Authenticate a Rucio account via RefreshOIDC.
X-Rucio-Account required | string |
X-Rucio-Auth-Token required | string |
curl --request GET \ --url http://undefinedundefined/auth/oidc_refresh \ --header 'X-Rucio-Account: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Create or set the value of an option.
section required | string The section. |
option required | string The option of the section. |
value required | string The value to set. |
curl --request PUT \ --url http://undefinedundefined/config/{section}/{option}/{value} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
"Created"
Returns the value of an option
section required | string The section. |
option required | string The option of the section. |
curl --request GET \ --url http://undefinedundefined/config/{section}/{option} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
"string"
Delete an option of a section.
section required | string The section. |
option required | string The option of the section. |
curl --request DELETE \ --url http://undefinedundefined/config/{section}/{option} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
section required | string The section to return. |
bytes required | integer The new limit in bytes. |
{- "bytes": 0
}
{ }
Create or set the configuration option in the requested section.
The request body is expected to contain a json {'section': {'option': 'value'}}.
{ }
"Created"
Sign a url for a limited lifetime for a particular srevice.
rse required | string The RSE to authenticate against. |
lifetime | string The lifetime, default 600s. |
svc | string The service, default gcs. |
op | string The operation. |
url required | string The Url of the authentication. |
X-Rucio-Account | string Account identifier. |
X-Rucio-VO | string VO name (Multi-VO only). |
X-Rucio-AppID | string Application identifier. |
curl --request GET \ --url 'http://undefinedundefined/credentials/signurl?rse=SOME_STRING_VALUE&lifetime=SOME_STRING_VALUE&svc=SOME_STRING_VALUE&op=SOME_STRING_VALUE&url=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "key": "string",
- "value": "string"
}
]
Return all data identifiers in the given scope.
scope required | string The scope. |
name | string The name of the data identifier (did). |
recursive | boolean If true, retrieves child identifiers recursively for non-file types. |
curl --request GET \ --url 'http://undefinedundefined/dids/{scope}/?name=SOME_STRING_VALUE&recursive=SOME_BOOLEAN_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string",
- "type": "F",
- "parent": "string",
- "level": 0
}
]
Returns the dataset associated with a GUID.
guid required | string The GUID to query buy. |
curl --request GET \ --url http://undefinedundefined/dids/{guid}/guid \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string"
}
]
List all data identifiers in a scope which match a given metadata.
scope required | string The scope of the data identifiers. |
type | string Default: "collection" Enum: "all" "collection" "container" "dataset" "file" The did type to search for. |
limit | integer The maximum number od dids returned. |
long | boolean Default: false Provides a longer output, otherwise just prints names. |
recursive | boolean Recursively list chilred. |
created_before | string Date string in RFC-1123 format where the creation date was earlier. |
created_after | string Date string in RFC-1123 format where the creation date was later. |
length | integer Exact number of attached DIDs. |
length.gt | integer Number of attached DIDs greater than. |
length.lt | integer Number of attached DIDs less than. |
length.gte | integer Number of attached DIDs greater than or equal to |
length.lte | integer Number of attached DIDs less than or equal to. |
name | string Name or pattern of a did. |
curl --request GET \ --url 'http://undefinedundefined/dids/{scope}/dids/search?type=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&long=SOME_BOOLEAN_VALUE&recursive=SOME_BOOLEAN_VALUE&created_before=SOME_STRING_VALUE&created_after=SOME_STRING_VALUE&length=SOME_INTEGER_VALUE&length.gt=SOME_INTEGER_VALUE&length.lt=SOME_INTEGER_VALUE&length.gte=SOME_INTEGER_VALUE&length.lte=SOME_INTEGER_VALUE&name=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- { }
]
List all replicas for a did.
scope_name required | string The scope and the name of the did. |
long | object Flag to trigger long output. |
curl --request GET \ --url 'http://undefinedundefined/dids/{scope_name}/files?long=SOME_OBJECT_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[ ]
Returns the content history of a data identifier.
scope_name required | string The scope and the name of the did. |
curl --request GET \ --url http://undefinedundefined/dids/{scope_name}/dids/history \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string",
- "type": "string",
- "bytes": 0,
- "adler32": "string",
- "md5": "string",
- "deleted_at": "string",
- "created_at": "string",
- "updated_at": "string"
}
]
Returns the contents of a data identifier.
scope_name required | string The scope and the name of the did. |
curl --request GET \ --url http://undefinedundefined/dids/{scope_name}/dids \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string",
- "type": "string",
- "bytes": 0,
- "adler32": "string",
- "md5": "string"
}
]
Detach data identifiers from data identifiers.
scope_name required | string The scope and the name of the did. |
required | Array of objects The dids to detach. |
{- "dids": [
- {
- "scope": "string",
- "name": "string"
}
]
}
Append data identifiers to data identifiers.
scope_name required | string The scope and the name of the did. |
rse | string The name of the rse. |
account | string The account which attaches the dids. |
required | object The dids to attach. |
{- "rse": "string",
- "account": "string",
- "dids": {
- "account": "string",
- "scope": "string",
- "name": "string"
}
}
"Created"
Get the metadata of a did.
scope_name required | string The scope and the name of the did. |
plugin | string Default: "DID_COLUMN" The plugin to use. |
curl --request GET \ --url 'http://undefinedundefined/dids/{scope_name}/meta?plugin=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
{ }
Deletes the specified metadata from the did.
scope_name required | string The scope and the name of the did. |
key | string The key to delete. |
curl --request DELETE \ --url 'http://undefinedundefined/dids/{scope_name}/meta?key=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Add metadata to a did.
scope_name required | string The scope and the name of the did. |
meta required | object The metadata to add. A dictionary containing the metadata name as key and the value as value. |
recursive | boolean Default: false Flag if the metadata should be applied recirsively to children. |
{- "meta": { },
- "recursive": false
}
"Created"
Add metadata to a did.
scope_name required | string The scope and the name of the did. |
key required | string The key for the metadata. |
value required | object The value to set. |
{- "value": { }
}
"Created"
Adds metadata in a bulk.
required | Array of objects A list with all the dids and the metadata. |
{- "dids": [
- {
- "scope": "string",
- "name": "string",
- "meta": { }
}
]
}
"Created"
Lists all rules of a given did.
scope_name required | string The scope and the name of the did. |
curl --request GET \ --url http://undefinedundefined/dids/{scope_name}/rules \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- { }
]
Lists all parents of the did.
scope_name required | string The scope and the name of the did. |
curl --request GET \ --url http://undefinedundefined/dids/{scope_name}/parents \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string",
- "type": "string"
}
]
Gets all associated rules for a file.
scope_name required | string The scope and the name of the did. |
curl --request GET \ --url http://undefinedundefined/dids/{scope_name}/associated_rules \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "id": "string",
- "subscription_id": "string",
- "account": "string",
- "scope": "string",
- "name": "string",
- "state": "string",
- "rse_expression": "string"
}
]
Get all followers for a specific did.
scope_name required | string The scope and the name of the did. |
curl --request GET \ --url http://undefinedundefined/dids/{scope_name}/follow \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "user": "string"
}
]
Mark the input DID as not followed
scope_name required | string The scope and the name of the did. |
account required | string The account to unfollow the did. |
{- "account": "string"
}
Mark the input DID as being followed by the given account.
scope_name required | string The scope and the name of the did. |
account required | string The account to follow the did. |
{- "account": "string"
}
Add new Dids in bulk.
scope required | string The did scope. |
name required | string The did name. |
type required | string Enum: "F" "D" "C" "A" "X" "Y" "Z" The type of the did. |
account | string The account associated with the did. |
statuses | string The monotonic status |
[- {
- "scope": "string",
- "name": "string",
- "type": "F",
- "account": "string",
- "statuses": "string"
}
]
"Created"
Creates a sample from an input collection.
input_scope required | string The input scope. |
input_name required | string The input name. |
output_scope required | string The output scope. |
output_name required | string The output name. |
nbfiles required | string The number of files to register in the output dataset. |
curl --request POST \ --url http://undefinedundefined/dids/{input_scope}/{input_name}/{output_scope}/{output_name}/{nbfiles}/sample \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
"Created"
Creates a sample from an input collection.
Parameters (source and destination) for the files in the sample to be created
input_scope required | string The input scope. |
input_name required | string The input name. |
output_scope required | string The output scope. |
output_name required | string The output name. |
nbfiles required | string The number of files to register in the output dataset. |
{- "input_scope": "string",
- "input_name": "string",
- "output_scope": "string",
- "output_name": "string",
- "nbfiles": "string"
}
"Created"
Attaches a did to another did
{- "ignore_duplicates": false,
- "attachments": [ ]
}
"Created"
Returns a list of recent identifiers.
type | string The type of the did. |
curl --request GET \ --url 'http://undefinedundefined/dids/new?type=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string",
- "did_type": "string"
}
]
Resurrect all given dids.
scope | string The scope of the did. |
name | string The name of the did |
[- {
- "scope": "string",
- "name": "string"
}
]
"Created"
List all metadata of a list of data identifiers.
required | Array of objects The dids. |
inherit | boolean Default: false Concatenated the metadata of the parent if set to true. |
{- "dids": [
- {
- "name": "string",
- "scope": "string"
}
], - "inherit": false
}
[- { }
]
List files in multiple dids
scope required | string The did scope. |
name required | string The did name. |
[- {
- "scope": "string",
- "name": "string"
}
]
[- {
- "parent_scope": "string",
- "parent_name": "string",
- "scope": "string",
- "name": "string",
- "bytes": 0,
- "guid": "string",
- "events": 0,
- "adler32": "string"
}
]
Get a single data identifier.
scope_name required | string The scope and the name of the did. |
dynamic_depth | string Enum: "FILE" "DATASET" The DID type at which to stop the dynamic length/size estimation |
dynamic | string Deprecated Same as dynamic_depth = "FILE" |
curl --request GET \ --url 'http://undefinedundefined/dids/{scope_name}/status?dynamic_depth=SOME_STRING_VALUE&dynamic=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
{- "scope": "string",
- "name": "string",
- "type": "string",
- "account": "string",
- "open": true,
- "monotonic": true,
- "expired_at": "string",
- "length": 0,
- "bytes": 0
}
Atomic method used by the RucioFileCatalog plugin in Dirac that:
lfns required | Array of objects List of lfn (dictionary {'lfn': |
ignore_availability | boolean If the availability should be ignored. |
parents_metadata | object Metadata for selected hierarchy DIDs. |
{- "lfns": [
- { }
], - "ignore_availability": true,
- "parents_metadata": { }
}
"Created"
Export data from rucio.
distance | boolean Should the distance be enabled? |
curl --request GET \ --url 'http://undefinedundefined/export?distance=SOME_BOOLEAN_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
{ }
executable | string Name of the executable. |
hostname | string Name of the host. |
pid | integer UNIX Process ID as a number, e.g., 1234. |
older_than | integer Ignore specified heartbeats older than specified nr of seconds. |
payload | string Payload identifier which can be further used to identify the work a certain thread is executing. |
{- "executable": "string",
- "hostname": "string",
- "pid": 0,
- "older_than": 0,
- "payload": "string"
}
Creates a new UserPass identity and maps it to an account.
account required | string The account for the identity. |
X-Rucio-Username required | string Username for the identity. |
X-Rucio-Password required | string The password for the identity. |
X-Rucio-Email | string The email for the identity. |
curl --request PUT \ --url 'http://undefinedundefined/identities/{account}/userpass?X-Rucio-Username=SOME_STRING_VALUE&X-Rucio-Password=SOME_STRING_VALUE&X-Rucio-Email=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
"Created"
Creates a new X509 identity and maps it to an account.
account required | string The account for the identity. |
X-Rucio-Email | string The email for the identity. |
curl --request PUT \ --url 'http://undefinedundefined/identities/{account}/x509?X-Rucio-Email=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
"Created"
Creates a new GSS identity and maps it to an account.
account required | string The account for the identity. |
X-Rucio-Email | string The email for the identity. |
curl --request PUT \ --url 'http://undefinedundefined/identities/{account}/gss?X-Rucio-Email=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
"Created"
List all identities mapped to an account.
identity_key required | string Identity string. |
type required | string Identity type. |
curl --request GET \ --url http://undefinedundefined/identities/{identity_key}/{type}/accounts \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- { }
]
Import data into rucio
object Rse data with rse name as key. | |
object Distances data with src rse name as key. | |
Array of objects Account data. |
{- "rses": {
- "rse name1": {
- "rse_type": "DISK"
}, - "rse name2": {
- "rse_type": "DISK"
}
}, - "distances": {
- "src rse1": {
- "dest rse1": {
- "distance": 0,
- "ranking": 0
}, - "dest rse2": {
- "distance": 0,
- "ranking": 0
}
}, - "src rse2": {
- "dest rse1": {
- "distance": 0,
- "ranking": 0
}, - "dest rse2": {
- "distance": 0,
- "ranking": 0
}
}
}, - "accounts": [
- {
- "account": "string",
- "email": "string",
- "identities": [
- {
- "type": "X509",
- "identity": "string",
- "password": "string"
}
]
}
]
}
"Created"
curl --request GET \ --url http://undefinedundefined/lifetime_exceptions/ \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "id": "string",
- "scope": "string",
- "name": "string",
- "did_type": "F",
- "account": "string",
- "pattern": "string",
- "comments": "string",
- "state": "A",
- "created_at": "string",
- "expires_at": "string"
}
]
Creates a Lifetime Exception.
Array of objects List of dids associated with the lifetime exception. | |
pattern | string The pattern of the lifetime exception. |
comments | string The comment for the lifetime exception. |
expires_at | string The expiration date for the lifetime exception. |
{- "dids": [
- {
- "name": "string"
}
], - "pattern": "string",
- "comments": "string",
- "expires_at": "string"
}
"string"
Get a single Lifetime Exception.
exception_id required | string The id of the lifetime exception. |
curl --request GET \ --url http://undefinedundefined/lifetime_exceptions/{exception_id} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "id": "string",
- "scope": "string",
- "name": "string",
- "did_type": "F",
- "account": "string",
- "pattern": "string",
- "comments": "string",
- "state": "A",
- "created_at": "string",
- "expires_at": "string"
}
]
Approve/Reject a Lifetime Exception.
exception_id required | string The id of the Lifetime Exception. |
state | string Enum: "A" "R" The new state for the Lifetime Exception. |
{- "state": "A"
}
"Created"
Get all dataset locks for an associated rse.
rse required | string The rse name. |
did_type | string Value: "dataset" The did type to filter for. |
{- "did_type": "dataset"
}
[- {
- "rse_id": "string",
- "rse": "string",
- "scope": "string",
- "name": "string",
- "rule_id": "string",
- "account": "string",
- "state": "R",
- "length": 0,
- "bytes": 0,
- "accessed_at": "string"
}
]
Get all dataset locks for an associated rse.
scope_name required | string The scope name. |
did_type | string Value: "dataset" The did type to filter for. |
{- "did_type": "dataset"
}
[- {
- "rse_id": "string",
- "rse": "string",
- "scope": "string",
- "name": "string",
- "rule_id": "string",
- "account": "string",
- "state": "R",
- "length": 0,
- "bytes": 0,
- "accessed_at": "string"
}
]
Get all dataset locks for the associated dids.
Array of objects The dids associated with the locks. |
{- "dids": [
- {
- "scope": "string",
- "name": "string",
- "type": "dataset"
}
]
}
[- {
- "rse_id": "string",
- "rse": "string",
- "scope": "string",
- "name": "string",
- "rule_id": "string",
- "account": "string",
- "state": "R",
- "length": 0,
- "bytes": 0,
- "accessed_at": "string"
}
]
Creates a new allowed key (value is NULL).
key required | string The name of the key. |
key_type | string The key type. |
value_type | string The value type. |
value_regexp | string The value regexpression. |
{- "key_type": "string",
- "value_type": "string",
- "value_regexp": "string"
}
"Created"
List all values for a key.
key required | string The reference key. |
curl --request GET \ --url http://undefinedundefined/meta_conventions/{key}/ \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- "string"
]
Creates a new value for a key.
key required | string The reference key. |
value required | string The new value associated with a key. |
{- "value": "string"
}
"Created"
Creates a new allowed key (value is NULL).
key required | string The name of the key. |
key_type | string The key type. |
value_type | string The value type. |
value_regexp | string The value regexpression. |
{- "key_type": "string",
- "value_type": "string",
- "value_regexp": "string"
}
"Created"
List all values for a key.
key required | string The reference key. |
curl --request GET \ --url http://undefinedundefined/meta/{key}/ \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- "string"
]
Creates a new value for a key.
key required | string The reference key. |
value required | string The new value associated with a key. |
{- "value": "string"
}
"Created"
Get Metalink redirect.
scope_name required | string The data identifier (scope)/(name). |
ip | string The client ip. |
fqdn | string |
site | string |
schemes | Array of arrays |
select | string |
sort | string |
curl --request GET \ --url 'http://undefinedundefined/redirect/{scope_name}/metalink?ip=SOME_STRING_VALUE&fqdn=SOME_STRING_VALUE&site=SOME_STRING_VALUE&schemes=SOME_ARRAY_VALUE&select=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
Get the header redirect.
scope_name required | string The data identifier (scope)/(name). |
ip | string The client ip. |
fqdn | string |
site | string |
schemes | Array of arrays |
select | string |
sort | string |
rse | string |
curl --request GET \ --url 'http://undefinedundefined/redirect/{scope_name}?ip=SOME_STRING_VALUE&fqdn=SOME_STRING_VALUE&site=SOME_STRING_VALUE&schemes=SOME_ARRAY_VALUE&select=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&rse=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
"string"
List all replicas for a DID.
limit | integer The maximum number pfns per replica to return. |
select | string Requested sorting of the result, e.g., 'geoip', 'random'. |
sort | string Requested sorting of the result, e.g., 'geoip', 'random'. |
X-Forwarded-For | string The client ip address. |
client_location | string The clients location. |
Array of objects List of Dids. | |
schemes | Array of strings A list of schemes to filter the replicas. |
sort | string Requested sorting of the result, e.g., 'geoip', 'random'. |
unavailable | boolean Deprecated If unavailable rse should be considered. |
ignore_availability | boolean If the availability should be ignored. |
rse_expression | string The RSE expression to restrict on a list of RSEs. |
all_states | boolean Return all replicas whatever state they are in. Adds an extra 'states' entry in the result dictionary. |
domain | string The network domain for the call, either None, 'wan' or 'lan'. None is fallback to 'wan', 'all' is both ['lan','wan'] |
signature_lifetime | integer If supported, in seconds, restrict the lifetime of the signed PFN. |
resolve_archives | boolean When set to True, find archives which contain the replicas. |
resolve_parents | boolean When set to True, find all parent datasets which contain the replicas. |
updated_after | string datetime object (UTC time), only return replicas updated after this time |
nrandom | integer The maximum number of replicas to return. |
{- "client_location": "string",
- "dids": [
- {
- "scope": "string",
- "name": "string"
}
], - "schemes": [
- "string"
], - "sort": "string",
- "unavailable": true,
- "ignore_availability": true,
- "rse_expression": "string",
- "all_states": true,
- "domain": "string",
- "signature_lifetime": 0,
- "resolve_archives": true,
- "resolve_parents": true,
- "updated_after": "string",
- "nrandom": 0
}
[- {
- "scope": "string",
- "name": "string",
- "bytes": 0,
- "md5": "string",
- "adler32": "string",
- "pfns": [ ],
- "rses": [ ]
}
]
List all replicas for data identifiers.
scope_name required | string The DID associated with the replicas. |
schemes | string The schemes of the replicas. |
select | string Enum: "geoip" "random" The sorting algorithm. |
limit | integer The maximum number of replicas returned. |
X-Forwarded-For | string The client ip |
curl --request GET \ --url 'http://undefinedundefined/replicas/{scope_name}?schemes=SOME_STRING_VALUE&select=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'X-Forwarded-For: SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string",
- "bytes": 0,
- "md5": "string",
- "adler32": "string",
- "pfns": [ ],
- "rses": "string"
}
]
List the suspicious replicas on a list of RSEs.
rse_expression | string The RSE expression to filter for. |
younger_than | string Date to filter for. |
nattempts | integer The maximum number of attempts to make. |
curl --request GET \ --url 'http://undefinedundefined/replicas/suspicious?rse_expression=SOME_STRING_VALUE&younger_than=SOME_STRING_VALUE&nattempts=SOME_INTEGER_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string",
- "rse": "string",
- "rse_id": "string",
- "cnt": 0,
- "created_at": "string"
}
]
Declare a list of suspicious replicas.
pfns | Array of strings The list of pfns. |
reason | string The reason for the declaration. |
{- "pfns": [
- "string"
], - "reason": "string"
}
[ ]
List the bad or suspicious replicas by states.
state | string Enum: "SUSPICIOUS" "BAD" The state of the file. |
rse | string The rse name. |
younger_than | string <date-time> Date to select bad replicas younger than this date. |
older_than | string <date-time> Date to select bad replicas older than this date. |
limit | integer The maximum number of replicas returned. |
list_pfns | boolean Flag to include pfns. |
curl --request GET \ --url 'http://undefinedundefined/replicas/bad/states?state=SOME_STRING_VALUE&rse=SOME_STRING_VALUE&younger_than=SOME_STRING_VALUE&older_than=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&list_pfns=SOME_BOOLEAN_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string",
- "type": "string"
}
]
Return a summary of the bad replicas by incident.
rse_expression | string The RSE expression. |
from_date | string <date-time> The start date. |
to_date | string <date-time> The end date. |
curl --request GET \ --url 'http://undefinedundefined/replicas/bad/summary?rse_expression=SOME_STRING_VALUE&from_date=SOME_STRING_VALUE&to_date=SOME_STRING_VALUE' \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "rse": "string",
- "rse_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "reason": "string"
}
]
Declare a list of bad PFNs.
expires_at | string <date-time> The expires at value. Only apply to TEMPORARY_UNAVAILABLE. |
pfns | Array of strings The list of pfns associated with the bad PFNs. |
state | string Enum: "BAD" "SUSPICIOUS" "TEMPORARY_UNAVAILABLE" The state to set the PFNs to. |
reason | string The reason for the change. |
{- "expires_at": "2019-08-24T14:15:22Z",
- "pfns": [
- "string"
], - "state": "BAD",
- "reason": "string"
}
Declare a list of bad replicas by DID.
expires_at | string <date-time> The expires at value. |
Array of objects The list of dids associated with the bad replicas. | |
rse | string The name of the rse. |
reason | string The reason for the change. |
{- "expires_at": "2019-08-24T14:15:22Z",
- "dids": [
- {
- "scope": "string",
- "name": "string"
}
], - "rse": "string",
- "reason": "string"
}
[- "string"
]
List dataset replicas per RSE.
rse required | string The rse to filter for. |
curl --request GET \ --url http://undefinedundefined/replicas/rse/{rse} \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'
[- {
- "scope": "string",
- "name": "string",
- "rse": "string",
- "rse_id": "string",
- "bytes": 0,
- "length": 0,
- "available_bytes": 0,
- "available_length": 0,
- "state": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "accessed_at": "2019-08-24T14:15:22Z"
}
]
Declares a list of bad replicas.
replicas | Array of strings The list of pfns or list of dicts with "scope", "name", "rse_id"/"rse" |
pfns | Array of strings Deprecated The list of pfns, for backward compatibility with older versions of the ReplicaClient |
reason | string The reason for the declaration. |
force | boolean If true, ignore existing replica status in the bad_replicas table. |
{- "replicas": [
- "string"
], - "pfns": [
- "string"
], - "reason": "string",
- "force": true
}
[ ]