diff --git a/html/rest_api_doc.html b/html/rest_api_doc.html index 53bdd251ad..db04039872 100644 --- a/html/rest_api_doc.html +++ b/html/rest_api_doc.html @@ -1852,16 +1852,16 @@ data-styled.g14[id="sc-crzoAE"]{content:"iUxAWq,"}/*!sc*/ .dvcDrG{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/ .iPqByX{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/ -.bRmrKA{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(0);-ms-transform:rotateZ(0);transform:rotateZ(0);}/*!sc*/ -.bRmrKA polygon{fill:white;}/*!sc*/ .dqYXmg{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/ .dqYXmg polygon{fill:#1d8127;}/*!sc*/ +.bRmrKA{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(0);-ms-transform:rotateZ(0);transform:rotateZ(0);}/*!sc*/ +.bRmrKA polygon{fill:white;}/*!sc*/ .dVWHLw{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/ .dVWHLw polygon{fill:#d41f1c;}/*!sc*/ .hGHhhO{height:18px;width:18px;min-width:18px;vertical-align:middle;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/ .cTsyql{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/ .cTsyql polygon{fill:#ffa500;}/*!sc*/ -data-styled.g15[id="sc-dIsUp"]{content:"dvcDrG,iPqByX,bRmrKA,dqYXmg,dVWHLw,hGHhhO,cTsyql,"}/*!sc*/ +data-styled.g15[id="sc-dIsUp"]{content:"dvcDrG,iPqByX,dqYXmg,bRmrKA,dVWHLw,hGHhhO,cTsyql,"}/*!sc*/ .eSYQnm{display:inline-block;padding:2px 8px;margin:0;background-color:#ffa500;color:#ffffff;font-size:13px;vertical-align:middle;line-height:1.6;border-radius:4px;font-weight:600;font-size:12px;}/*!sc*/ .eSYQnm + span[type]{margin-left:4px;}/*!sc*/ data-styled.g16[id="sc-bqGGPW"]{content:"eSYQnm,"}/*!sc*/ @@ -2194,12 +2194,12 @@ .ilvUMs ..sc-jXcxbT{color:#ffffff;}/*!sc*/ .ilvUMs:focus{box-shadow:inset 0 2px 2px rgba(0,0,0,0.45),0 2px 0 rgba(128,128,128,0.25);}/*!sc*/ data-styled.g114[id="sc-eEVmNe"]{content:"ilvUMs,"}/*!sc*/ -.bJzUtf{font-size:0.929em;line-height:20px;background-color:#cc3333;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/ .ldMUmp{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/ +.bJzUtf{font-size:0.929em;line-height:20px;background-color:#cc3333;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/ .ihNycv{font-size:0.929em;line-height:20px;background-color:#2F8132;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/ .blNLGm{font-size:0.929em;line-height:20px;background-color:#95507c;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/ .hIFOpc{font-size:0.929em;line-height:20px;background-color:#947014;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/ -data-styled.g115[id="sc-fmdNqN"]{content:"bJzUtf,ldMUmp,ihNycv,blNLGm,hIFOpc,"}/*!sc*/ +data-styled.g115[id="sc-fmdNqN"]{content:"ldMUmp,bJzUtf,ihNycv,blNLGm,hIFOpc,"}/*!sc*/ .flIrdF{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0px 0px 6px rgba(0,0,0,0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;-webkit-transition:all 0.25s ease;transition:all 0.25s ease;visibility:hidden;-webkit-transform:translateY(-50%) scaleY(0);-ms-transform:translateY(-50%) scaleY(0);transform:translateY(-50%) scaleY(0);}/*!sc*/ data-styled.g116[id="sc-ljsmAU"]{content:"flIrdF,"}/*!sc*/ .fQkroN{padding:10px;}/*!sc*/ @@ -2207,16 +2207,16 @@ .dfUAUz{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/ .dfUAUz > span{color:#333333;}/*!sc*/ data-styled.g118[id="sc-dTSzeu"]{content:"dfUAUz,"}/*!sc*/ -.jUGDyD{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);cursor:default;}/*!sc*/ -.jUGDyD:focus{outline:auto #1d8127;}/*!sc*/ -.jUGDyD::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/ -.jUGDyD:focus{outline:0;}/*!sc*/ +.lbYftx{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/ +.lbYftx:focus{outline:auto #1d8127;}/*!sc*/ .cGFwjB{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);cursor:default;}/*!sc*/ .cGFwjB:focus{outline:auto #d41f1c;}/*!sc*/ .cGFwjB::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/ .cGFwjB:focus{outline:0;}/*!sc*/ -.lbYftx{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/ -.lbYftx:focus{outline:auto #1d8127;}/*!sc*/ +.jUGDyD{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);cursor:default;}/*!sc*/ +.jUGDyD:focus{outline:auto #1d8127;}/*!sc*/ +.jUGDyD::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/ +.jUGDyD:focus{outline:0;}/*!sc*/ .fpOpCW{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#ffa500;background-color:rgba(255,165,0,0.1);cursor:default;}/*!sc*/ .fpOpCW:focus{outline:auto #ffa500;}/*!sc*/ .fpOpCW::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/ @@ -2225,7 +2225,7 @@ .NAUPn:focus{outline:auto #d41f1c;}/*!sc*/ .crRaBc{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#ffa500;background-color:rgba(255,165,0,0.1);}/*!sc*/ .crRaBc:focus{outline:auto #ffa500;}/*!sc*/ -data-styled.g119[id="sc-htmcrh"]{content:"jUGDyD,cGFwjB,lbYftx,fpOpCW,NAUPn,crRaBc,"}/*!sc*/ +data-styled.g119[id="sc-htmcrh"]{content:"lbYftx,cGFwjB,jUGDyD,fpOpCW,NAUPn,crRaBc,"}/*!sc*/ .cMoEZ{vertical-align:top;}/*!sc*/ data-styled.g123[id="sc-fWWYYk"]{content:"cMoEZ,"}/*!sc*/ .DvFer{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/ @@ -2264,7 +2264,7 @@ -
Error handling
ExceptionClass ExceptionMessage
 

Where ExceptionClass refers to Rucio Exceptions.

-

Account Limit

Delete a local account limit

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the accountlimit.

-
rse
required
string

The rse for the accountlimit.

-

Responses

Request samples

curl --request DELETE \
-  --url http://undefinedundefined/accountlimits/local/{account}/{rse} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create or update a local account limit

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the accountlimit.

+

Account Limit

Create or update a local account limit

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the accountlimit.

rse
required
string

The rse for the accountlimit.

Request Body schema: application/json
bytes
required
integer

The new limit in bytes.

Responses

Request samples

Content type
application/json
{
  • "bytes": 0
}

Response samples

Content type
application/json
"Created"

Delete a global account limit

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the accountlimit.

-
rse_expression
required
string

The rse expression for the accountlimit.

+

Request samples

Content type
application/json
{
  • "bytes": 0
}

Response samples

Content type
application/json
"Created"

Delete a local account limit

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the accountlimit.

+
rse
required
string

The rse for the accountlimit.

Responses

Request samples

curl --request DELETE \
-  --url http://undefinedundefined/accountlimits/global/{account}/{rse_expression} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create or update a global account limit

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the accountlimit.

+

Request samples

curl --request DELETE \
+  --url http://undefinedundefined/accountlimits/local/{account}/{rse} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create or update a global account limit

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the accountlimit.

rse_expression
required
string

The rse expression for the accountlimit.

Request Body schema: application/json
bytes
required
integer

The new limit in bytes.

Responses

Request samples

Content type
application/json
{
  • "bytes": 0
}

Response samples

Content type
application/json
"Created"

Account

Delete attribute

Delete an attribute of an account.

-
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-
key
required
string

The key of the account attribute to remove.

+

Request samples

Content type
application/json
{
  • "bytes": 0
}

Response samples

Content type
application/json
"Created"

Delete a global account limit

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the accountlimit.

+
rse_expression
required
string

The rse expression for the accountlimit.

Responses

Request samples

curl --request DELETE \
-  --url http://undefinedundefined/accounts/{account}/attr/{key} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create attribute

Create an attribute to an account.

+

Request samples

curl --request DELETE \
+  --url http://undefinedundefined/accountlimits/global/{account}/{rse_expression} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Account

Create attribute

Create an attribute to an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

key
required
string

The key of the account attribute.

Request Body schema: application/json
key
string

The key of the attribute. This would override the key defined in path.

@@ -2372,7 +2364,15 @@

Error handling

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Create scope

Creates a scopse with the given name for an account.

+

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Delete attribute

Delete an attribute of an account.

+
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

+
key
required
string

The key of the account attribute to remove.

+

Responses

Request samples

curl --request DELETE \
+  --url http://undefinedundefined/accounts/{account}/attr/{key} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create scope

Creates a scopse with the given name for an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

scope
required
string

The scope name.

Responses

Request samples

curl --request GET \
   --url http://undefinedundefined/accounts/{account}/limits/global/{rse_expression} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Delete identity

Delete an account identity.

-
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-
Request Body schema: application/json
identity
required
string

The identity.

-
authtype
required
string

The authtype.

-

Responses

Request samples

Content type
application/json
{
  • "identity": "string",
  • "authtype": "string"
}

Create identity

Grant an account identity access to an account.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Create identity

Grant an account identity access to an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

Request Body schema: application/json
identity
required
string

The identity.

authtype
required
string

The authtype.

@@ -2419,7 +2412,14 @@

Error handling

Request samples

Content type
application/json
{
  • "identity": "string",
  • "authtype": "string",
  • "email": "string",
  • "password": "none",
  • "default": false
}

Response samples

Content type
application/json
"Created"

List identities

Lists all identities for an account.

+

Request samples

Content type
application/json
{
  • "identity": "string",
  • "authtype": "string",
  • "email": "string",
  • "password": "none",
  • "default": false
}

Response samples

Content type
application/json
"Created"

Delete identity

Delete an account identity.

+
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

+
Request Body schema: application/json
identity
required
string

The identity.

+
authtype
required
string

The authtype.

+

Responses

Request samples

Content type
application/json
{
  • "identity": "string",
  • "authtype": "string"
}

List identities

Lists all identities for an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

Responses

Request samples

curl --request GET \
   --url http://undefinedundefined/accounts/{account}/usage/global/{rse_expression} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Delete

Delete an account.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Create

Create an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-

Responses

Request Body schema: application/json
type
required
string
Enum: "USER" "GROUP" "SERVICE"

The account type.

+
email
required
string

The email for the account.

+

Responses

Request samples

curl --request DELETE \
-  --url http://undefinedundefined/accounts/{account} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update

Update a parameter for an account.

+

Request samples

Content type
application/json
{
  • "type": "USER",
  • "email": "string"
}

Response samples

Content type
application/json
"Created"

Update

Update a parameter for an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

Request Body schema: application/json
object

Json object with key-value pairs corresponding to the new values of the parameters.

Responses

Request samples

Content type
application/json
{ }

Create

Create an account.

+

Request samples

Content type
application/json
{ }

Delete

Delete an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-
Request Body schema: application/json
type
required
string
Enum: "USER" "GROUP" "SERVICE"

The account type.

-
email
required
string

The email for the account.

-

Responses

Responses

Request samples

Content type
application/json
{
  • "type": "USER",
  • "email": "string"
}

Response samples

Content type
application/json
"Created"

List account parameters

Lists all parameters for an account.

+

Request samples

curl --request DELETE \
+  --url http://undefinedundefined/accounts/{account} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

List account parameters

Lists all parameters for an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

Responses

SAML Allow cross-site scripting

SAML Allow cross-site scripting. Explicit for Authentication.

-
Authorizations:
AuthToken

Responses

Request samples

curl --request OPTIONS \
-  --url http://undefinedundefined/auth/saml \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Post a SAML request

Post a SAML request

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Post a SAML request

Post a SAML request

Authorizations:
AuthToken

Responses

Request samples

curl --request POST \
+

Request samples

curl --request POST \
+  --url http://undefinedundefined/auth/saml \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SAML Allow cross-site scripting

SAML Allow cross-site scripting. Explicit for Authentication.

+
Authorizations:
AuthToken

Responses

Request samples

curl --request OPTIONS \
   --url http://undefinedundefined/auth/saml \
   --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

SAML

Authenticate a Rucio account via SAML.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string
X-Rucio-AppID
string
X-Forwarded-For
string

Responses

Request samples

curl --request GET \
   --url http://undefinedundefined/dids/{scope_name}/dids/history \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Detach dids from did

Detach data identifiers from data identifiers.

-
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

-
Request Body schema: application/json
required
Array of objects

The dids to detach.

-

Responses

Request samples

Content type
application/json
{
  • "dids": [
    ]
}

Add dids to did

Append data identifiers to data identifiers.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Add dids to did

Append data identifiers to data identifiers.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

Request Body schema: application/json
rse
string

The name of the rse.

account
string

The account which attaches the dids.

@@ -2808,7 +2802,13 @@

Error handling

Request samples

Content type
application/json
{
  • "rse": "string",
  • "account": "string",
  • "dids": {
    }
}

Response samples

Content type
application/json
"Created"

Get did

Returns the contents of a data identifier.

+

Request samples

Content type
application/json
{
  • "rse": "string",
  • "account": "string",
  • "dids": {
    }
}

Response samples

Content type
application/json
"Created"

Detach dids from did

Detach data identifiers from data identifiers.

+
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

+
Request Body schema: application/json
required
Array of objects

The dids to detach.

+

Responses

Request samples

Content type
application/json
{
  • "dids": [
    ]
}

Get did

Returns the contents of a data identifier.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

Responses

Request samples

curl --request GET \
   --url http://undefinedundefined/dids/{scope_name}/dids \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Delete metadata

Deletes the specified metadata from the did.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Add metadata

Add metadata to a did.

+
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

+
Request Body schema: application/json
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.

+

Responses

Request samples

Content type
application/json
{
  • "meta": { },
  • "recursive": false
}

Response samples

Content type
application/json
"Created"

Delete metadata

Deletes the specified metadata from the did.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

query Parameters
key
string

The key to delete.

Responses

Request samples

curl --request DELETE \
+

Request samples

curl --request DELETE \
   --url 'http://undefinedundefined/dids/{scope_name}/meta?key=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Add metadata

Add metadata to a did.

-
Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

-
Request Body schema: application/json
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.

-

Responses

Request samples

Content type
application/json
{
  • "meta": { },
  • "recursive": false
}

Response samples

Content type
application/json
"Created"

Get metadata

Get the metadata of a did.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Get metadata

Get the metadata of a did.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

query Parameters
plugin
string
Default: "DID_COLUMN"

The plugin to use.

Responses

Request samples

curl --request GET \
   --url http://undefinedundefined/dids/{scope_name}/associated_rules \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Delete follow

Mark the input DID as not followed

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Post follow

Mark the input DID as being followed by the given account.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

-
Request Body schema: application/json
account
required
string

The account to unfollow the did.

-

Responses

Request Body schema: application/json
account
required
string

The account to follow the did.

+

Responses

Request samples

Content type
application/json
{
  • "account": "string"
}

Post follow

Mark the input DID as being followed by the given account.

+

Request samples

Content type
application/json
{
  • "account": "string"
}

Delete follow

Mark the input DID as not followed

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

-
Request Body schema: application/json
account
required
string

The account to follow the did.

-

Responses

Request Body schema: application/json
account
required
string

The account to unfollow the did.

+

Responses

Request samples

Content type
application/json
{
  • "account": "string"
}

Get followers

Get all followers for a specific did.

+

Request samples

Content type
application/json
{
  • "account": "string"
}

Get followers

Get all followers for a specific did.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

Responses

Request samples

curl --request GET \
   --url 'http://undefinedundefined/subscriptions/{account}/{name}/rules?state=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • null
]

Update subscription

Update an existing subscription.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • null
]

Create subscription

Create a new subscription

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

name
required
string

The subscription name.

Request Body schema: application/json
required
object

The values for the new subscription.

-

Responses

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Create subscription

Create a new subscription

+

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
"string"

Update subscription

Update an existing subscription.

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

name
required
string

The subscription name.

Request Body schema: application/json
required
object

The values for the new subscription.

-

Responses

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
"string"

Get Subscription

Retrieve a subscription.

+

Request samples

Content type
application/json
{
  • "options": {
    }
}

Get Subscription

Retrieve a subscription.

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

name
required
string

The subscription name.

Responses

Request samples

curl --request GET \
   --url 'http://undefinedundefined/requests/metrics?dest_rse=SOME_STRING_VALUE&source_rse=SOME_STRING_VALUE&activity=SOME_STRING_VALUE&group_by_rse_attribute=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Rucio Storage Elements

Delete RSE Attribute

Delete an RSE attribute for given RSE name.

-
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
key
required
string

The name of the attribute of the RSE.

-

Responses

Request samples

curl --request DELETE \
-  --url http://undefinedundefined/rses/{rse}/attr/{key} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create RSE Attribute

Create a RSE attribute with given RSE name.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Rucio Storage Elements

Create RSE Attribute

Create a RSE attribute with given RSE name.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

key
required
string

The name of the attribute of the RSE.

Request Body schema: application/json
value
required
string

The value of the RSE attribute.

@@ -3472,16 +3464,24 @@

Error handling

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Delete Rse Distance

Delete distance information between source RSE and destination RSE.

+

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Delete RSE Attribute

Delete an RSE attribute for given RSE name.

+
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

+
key
required
string

The name of the attribute of the RSE.

+

Responses

Request samples

curl --request DELETE \
+  --url http://undefinedundefined/rses/{rse}/attr/{key} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create Rse Distance

Post a rse distance.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

destination
required
string

The name of the destination Rucio Storage Element.

-

Responses

Request Body schema: application/json
distance
integer

The distance between RSEs.

+
ranking
integer
Deprecated

Same as distance.

+

Responses

Request samples

curl --request DELETE \
-  --url http://undefinedundefined/rses/{source}/distances/{destination} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Deleted"

Update Rse Distance

Update rse distance information.

+

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Update Rse Distance

Update rse distance information.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

destination
required
string

The name of the destination Rucio Storage Element.

Request Body schema: application/json
distance
integer

The distance between the RSEs.

@@ -3490,16 +3490,16 @@

Error handling

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Create Rse Distance

Post a rse distance.

+

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Delete Rse Distance

Delete distance information between source RSE and destination RSE.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

destination
required
string

The name of the destination Rucio Storage Element.

-
Request Body schema: application/json
distance
integer

The distance between RSEs.

-
ranking
integer
Deprecated

Same as distance.

-

Responses

Responses

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Get Rse Distances

Returns the distances between a source and destination rse.

+

Request samples

curl --request DELETE \
+  --url http://undefinedundefined/rses/{source}/distances/{destination} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Deleted"

Get Rse Distances

Returns the distances between a source and destination rse.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

destination
required
string

The name of the destination Rucio Storage Element.

Responses

Request samples

curl --request GET \
   --url http://undefinedundefined/rses/{source}/distances/{destination} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Delete Protocol Attributes

Delete all protocol attributes.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Update Protocol Attributes

Updates attributes of an existing protocol entry. Because protocol identifier, hostname, and port are used as unique identifier they are immutable.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

scheme
required
string

The protocol identifier.

hostname
required
string

The hostname of the protocol.

port
required
integer

The port of the protocol.

-

Responses

Responses

Request samples

curl --request DELETE \
+

Request samples

curl --request PUT \
   --url http://undefinedundefined/rses/{rse}/protocols/{scheme}/{hostname}/{port} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update Protocol Attributes

Updates attributes of an existing protocol entry. Because protocol identifier, hostname, and port are used as unique identifier they are immutable.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "staging_area": "string",
  • "rse_type": "DISK",
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "credentials": "string",
  • "domain": [ ],
  • "id": "string",
  • "lfn2pfn_algorithm": "string",
  • "qos_class": "string",
  • "rse": "string",
  • "sign_url": "string",
  • "verify_checksum": true,
  • "protocols": [
    ]
}

Delete Protocol Attributes

Delete all protocol attributes.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

scheme
required
string

The protocol identifier.

hostname
required
string

The hostname of the protocol.

port
required
integer

The port of the protocol.

-

Responses

Responses

Request samples

curl --request PUT \
+

Request samples

curl --request DELETE \
   --url http://undefinedundefined/rses/{rse}/protocols/{scheme}/{hostname}/{port} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "staging_area": "string",
  • "rse_type": "DISK",
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "credentials": "string",
  • "domain": [ ],
  • "id": "string",
  • "lfn2pfn_algorithm": "string",
  • "qos_class": "string",
  • "rse": "string",
  • "sign_url": "string",
  • "verify_checksum": true,
  • "protocols": [
    ]
}

List RSE Protocols

List all supported protocols of the given RSE.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

List RSE Protocols

List all supported protocols of the given RSE.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

Responses

Request samples

curl --request GET \
   --url http://undefinedundefined/rses/{rse}/usage/history \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Delete Rse Limit

Delete an rse limit

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Update Rse Limit

Update an rse limit.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
Request Body schema: application/json
name
required
string

The name of the limit.

+
Request Body schema: application/json
name
string

The name of the limit.

+
value
integer

The value of the limit.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Update Rse Limit

Update an rse limit.

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": 0
}

Delete Rse Limit

Delete an rse limit

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
Request Body schema: application/json
name
string

The name of the limit.

-
value
integer

The value of the limit.

+
Request Body schema: application/json
name
required
string

The name of the limit.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": 0
}

Get Rse Limits

Get the rse limits.

+

Request samples

Content type
application/json
{
  • "name": "string"
}

Get Rse Limits

Get the rse limits.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

Responses

Request samples

curl --request GET \
   --url http://undefinedundefined/rses/{rse}/limits \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "limit name1": 0,
  • "limit name2": 0
}

Delete QoS Policy

Delete QoS policy from RSE.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "limit name1": 0,
  • "limit name2": 0
}

Add QoS policy

Add a QoS Policy to a RSE.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

policy
required
string

The QoS policy to add to and rse.

-

Responses

Responses

Request samples

curl --request DELETE \
+

Request samples

curl --request POST \
   --url http://undefinedundefined/rses/{rse}/qos_policy/{policy} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Add QoS policy

Add a QoS Policy to a RSE.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Created"

Delete QoS Policy

Delete QoS policy from RSE.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

policy
required
string

The QoS policy to add to and rse.

-

Responses

Responses

Request samples

curl --request POST \
+

Request samples

curl --request DELETE \
   --url http://undefinedundefined/rses/{rse}/qos_policy/{policy} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Created"

Disable RSE

Disable a specific RSE.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create RSE

Creates a RSE with all the metadata.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-

Responses

Request samples

curl --request DELETE \
-  --url http://undefinedundefined/rses/{rse} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update RSE

Update RSE properties.

-
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
Request Body schema: application/json
availability_read
boolean

The vailability of the RSE.

-
availability_write
boolean

The vailability of the RSE.

-
availability_delete
boolean

The vailability of the RSE.

-
deterministic
boolean

If the pfn is generated deterministicly.

+
Request Body schema: application/json
deterministic
boolean

If the pfn is generated deterministicly.

volatile
boolean

RSE cache.

city
string

The city of the RSE.

staging_area
string

Staging area.

region_code
string

The region code of the RSE.

country_name
string

The country name of the RSE.

+
continent
string

The continent of the RSE.

time_zone
string

The time zone of the RSE.

+
ISP
string

The internet service provider of the RSE.

rse_type
string
Enum: "DISK" "TAPE"

The rse type.

latitude
number

The latitude of the RSE.

-
longitude
number

The longitude of the RSE.

+
longitude
number

The longitude of the RSE.

+
ASN
string

The access service network of the RSE.

+
availability
integer
Deprecated

The availability of the RSE.

+
availability_read
boolean

If the RSE is readable.

+
availability_write
boolean

If the RSE is writable.

+
availability_delete
boolean

If the RSE is deletable.

Responses

Request samples

Content type
application/json
{
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "time_zone": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
"Created"

Create RSE

Creates a RSE with all the metadata.

+

Request samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true
}

Response samples

Content type
application/json
"Created"

Update RSE

Update RSE properties.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
Request Body schema: application/json
deterministic
boolean

If the pfn is generated deterministicly.

+
Request Body schema: application/json
availability_read
boolean

The vailability of the RSE.

+
availability_write
boolean

The vailability of the RSE.

+
availability_delete
boolean

The vailability of the RSE.

+
deterministic
boolean

If the pfn is generated deterministicly.

volatile
boolean

RSE cache.

city
string

The city of the RSE.

staging_area
string

Staging area.

region_code
string

The region code of the RSE.

country_name
string

The country name of the RSE.

-
continent
string

The continent of the RSE.

time_zone
string

The time zone of the RSE.

-
ISP
string

The internet service provider of the RSE.

rse_type
string
Enum: "DISK" "TAPE"

The rse type.

latitude
number

The latitude of the RSE.

-
longitude
number

The longitude of the RSE.

-
ASN
string

The access service network of the RSE.

-
availability
integer
Deprecated

The availability of the RSE.

-
availability_read
boolean

If the RSE is readable.

-
availability_write
boolean

If the RSE is writable.

-
availability_delete
boolean

If the RSE is deletable.

+
longitude
number

The longitude of the RSE.

Responses

Request samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true
}

Response samples

Content type
application/json
"Created"

Get RSE

Get details about a specific RSE.

+

Request samples

Content type
application/json
{
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "time_zone": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
"Created"

Disable RSE

Disable a specific RSE.

+
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

+

Responses

Request samples

curl --request DELETE \
+  --url http://undefinedundefined/rses/{rse} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Get RSE

Get details about a specific RSE.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

Responses

Request samples

curl --request GET \
   --url 'http://undefinedundefined/rses/?expression=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Rule

Delete a replication rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

-

Responses

Request samples

curl --request DELETE \
-  --url http://undefinedundefined/rules/{rule_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update the replication rules parameters

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Rule

Update the replication rules parameters

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

Request Body schema: application/json

Parameters for the new rule.

required
object

The parameters to change.

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Return a Rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

+

Request samples

Content type
application/json
{
  • "options": {
    }
}

Delete a replication rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

+

Responses

Request samples

curl --request DELETE \
+  --url http://undefinedundefined/rules/{rule_id} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Return a Rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

Responses

Response samples

Content type
application/json
[
  • "string"
]