From 6d5e9b47ffd075ff5c5b23ce43f0936205adb34a Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 26 Apr 2024 04:19:01 +0000 Subject: [PATCH] Documentation autoupdate --- html/rest_api_doc.html | 646 +++--- yaml/rest_api_doc_spec.yaml | 3908 +++++++++++++++++------------------ 2 files changed, 2277 insertions(+), 2277 deletions(-) diff --git a/html/rest_api_doc.html b/html/rest_api_doc.html index 316a56a3d17..82ca2ec856e 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 @@ -
Rucio logo
API docs by Redocly
Rucio logo
API docs by Redocly
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 accont limit

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the accountlimit.

+

Account Limit

Create or update a local accont 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
{ }

List identities

Lists all identities for 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.

+
email
required
string

The email.

+
password
string
Default: "none"

The password.

+
default
string
Default: false

Should this be the default account?

+

Responses

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.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

Responses

Request samples 

curl --request GET \
+

Request samples 

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

Response samples

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

Delete identity

Delete an account identity.

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

Response samples

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

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.

-
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.

-
email
required
string

The email.

-
password
string
Default: "none"

The password.

-
default
string
Default: false

Should this be the default account?

-

Responses

Request samples

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

Response samples

Content type
application/json
"Created"

List rules

Lists all rules for an account.

+

Request samples

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

List rules

Lists all rules 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'

List account parameters

Lists all parameters for an account.

+

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.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

Responses

Request samples 

curl --request GET \
+

Request samples 

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

Response samples

Content type
application/json
{
  • "account": "string",
  • "account_type": "string",
  • "status": "string",
  • "email": "string",
  • "suspended_at": "string",
  • "deleted_at": "string"
}

Delete

Delete an account.

+
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

+

Responses

Request samples 

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

Response samples

Content type
application/json
{
  • "account": "string",
  • "account_type": "string",
  • "status": "string",
  • "email": "string",
  • "suspended_at": "string",
  • "deleted_at": "string"
}

Update

Update a parameter for an account.

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

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.

-
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

Request samples

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

Response samples

Content type
application/json
"Created"

List

List all accounts.

+

Request samples

Content type
application/json
{ }

List

List all accounts.

Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
   --url http://undefinedundefined/accounts \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Auth

UserPass Allow cross-site scripting

UserPass Allow cross-site scripting. Explicit for Authentication.

-
Authorizations:
AuthToken

Responses

Request samples 

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

UserPass

Authenticate a Rucio account temporarily via username and password.

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

Response samples

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

Auth

UserPass

Authenticate a Rucio account temporarily via username and password.

Authorizations:
AuthToken
header Parameters
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.

@@ -2511,74 +2506,79 @@

Error handling

Responses

Request samples 

curl --request GET \
+

Request samples 

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'

GSS Allow cross-site scripting

GSS Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Username: SOME_STRING_VALUE'

UserPass Allow cross-site scripting

UserPass Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

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

GSS

Authenticate a Rucio account via GSS.

+

Request samples 

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

GSS

Authenticate a Rucio account via GSS.

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

Responses

Request samples 

curl --request GET \
+

Request samples 

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'

x509 Allow cross-site scripting

x509 Allow cross-site scripting. Explicit for Authentication.

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

GSS Allow cross-site scripting

GSS Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

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

x509

Authenticate a Rucio account via x509.

+

Request samples 

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

x509

Authenticate a Rucio account via x509.

Authorizations:
AuthToken
header Parameters
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.

Responses

Request samples 

curl --request GET \
+

Request samples 

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'

SSH Allow cross-site scripting

SSH Allow cross-site scripting. Explicit for Authentication.

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

x509 Allow cross-site scripting

x509 Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

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

SSH

Authenticate a Rucio account via SSH.

+

Request samples 

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

SSH

Authenticate a Rucio account via SSH.

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

Responses

Request samples 

curl --request GET \
+

Request samples 

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'

SSHChallengeToken Allow cross-site scripting

SSHChallengeToken Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-SSH-Signature: SOME_STRING_VALUE'

SSH Allow cross-site scripting

SSH Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

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

SSHChallengeToken

Authenticate a Rucio account via SSHChallengeToken.

+

Request samples 

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

SSHChallengeToken

Authenticate a Rucio account via SSHChallengeToken.

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

Responses

Request samples 

curl --request GET \
+

Request samples 

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'

SAML Allow cross-site scripting

SAML Allow cross-site scripting. Explicit for Authentication.

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

SSHChallengeToken Allow cross-site scripting

SSHChallengeToken Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
+

Request samples 

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

Post a SAML request

Post a SAML request

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request POST \
   --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

Post a SAML request

Post a SAML request

-
Authorizations:
AuthToken

Responses

Request samples 

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

Validate Allow cross-site scripting

Validate Allow cross-site scripting. Explicit for Authentication.

+ --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/validate \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Validate

Validate a Rucio auth token.

+

Request samples 

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

Validate

Validate a Rucio auth token.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/validate \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

OIDC Allow cross-site scripting

OIDC Allow cross-site scripting. Explicit for Authentication.

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

Validate Allow cross-site scripting

Validate Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

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

OIDC

Authenticate a Rucio account via OIDC.

+

Request samples 

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

OIDC

Authenticate a Rucio account via OIDC.

Authorizations:
AuthToken
header Parameters
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

Responses

Request samples 

curl --request GET \
+

Request samples 

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' \
@@ -2623,51 +2618,56 @@ 
Error handling

   --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'

TokenOIDC Allow cross-site scripting

TokenOIDC Allow cross-site scripting. Explicit for Authentication.

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

OIDC Allow cross-site scripting

OIDC Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

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

TokenOIDC

Authenticate a Rucio account via TokenOIDC.

+

Request samples 

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

TokenOIDC

Authenticate a Rucio account via TokenOIDC.

Authorizations:
AuthToken
header Parameters
X-Forwarded-For
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/oidc_token \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

CodeOIDC Allow cross-site scripting

CodeOIDC Allow cross-site scripting. Explicit for Authentication.

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

TokenOIDC Allow cross-site scripting

TokenOIDC Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

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

CodeOIDC

Authenticate a Rucio account via CodeOIDC.

+

Request samples 

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

CodeOIDC

Authenticate a Rucio account via CodeOIDC.

Authorizations:
AuthToken
header Parameters
X-Forwarded-For
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/oidc_code \
   --header 'X-Forwarded-For: SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

RedirectOIDC Allow cross-site scripting

RedirectOIDC Allow cross-site scripting. Explicit for Authentication.

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

CodeOIDC Allow cross-site scripting

CodeOIDC Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

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

RedirectOIDC

Authenticate a Rucio account via RedirectOIDC.

+

Request samples 

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

RedirectOIDC

Authenticate a Rucio account via RedirectOIDC.

Authorizations:
AuthToken
header Parameters
X-Rucio-Client-Fetch-Token
string

Responses

Request samples 

curl --request GET \
+

Request samples 

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'

RefreshOIDC Allow cross-site scripting

RefreshOIDC Allow cross-site scripting. Explicit for Authentication.

+ --header 'X-Rucio-Client-Fetch-Token: SOME_STRING_VALUE'

RedirectOIDC Allow cross-site scripting

RedirectOIDC Allow cross-site scripting. Explicit for Authentication.

Authorizations:
AuthToken

Responses

Request samples 

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

RefreshOIDC

Authenticate a Rucio account via RefreshOIDC.

+

Request samples 

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

RefreshOIDC

Authenticate a Rucio account via RefreshOIDC.

Authorizations:
AuthToken
header Parameters
X-Rucio-Account
required
string
X-Rucio-Auth-Token
required
string

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request GET \
   --url http://undefinedundefined/auth/oidc_refresh \
   --header 'X-Rucio-Account: SOME_STRING_VALUE' \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

RefreshOIDC Allow cross-site scripting

RefreshOIDC Allow cross-site scripting. Explicit for Authentication.

+
Authorizations:
AuthToken

Responses

Request samples 

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

Config

Create value

Create or set the value of an option.

Authorizations:
AuthToken
path Parameters
section
required
string

The section.

option
required
string

The option of the section.

@@ -2699,24 +2699,19 @@

Error handling

Request samples

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

Response samples

Content type
application/json
{ }

List

List the full configuration.

-
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/config \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Create

Create or set the configuration option in the requested section.

+

Request samples

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

Response samples

Content type
application/json
{ }

Create

Create or set the configuration option in the requested section.

Authorizations:
AuthToken
Request Body schema: application/json
object

The request body is expected to contain a json {'section': {'option': 'value'}}.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"Created"

Credentials

Cross-Site Scripting

Allow cross-site scripting. Explicit for Authentication.

+

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"Created"

List

List the full configuration.

Authorizations:
AuthToken

Responses

Request samples 

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

Sign URL

Sign a url for a limited lifetime for a particular srevice.

+

Request samples 

curl --request GET \
+  --url http://undefinedundefined/config \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Credentials

Sign URL

Sign a url for a limited lifetime for a particular srevice.

Authorizations:
AuthToken
query Parameters
rse
required
string

The RSE to authenticate against.

lifetime
string

The lifetime, default 600s.

svc
string

The service, default gcs.

@@ -2729,9 +2724,14 @@

Error handling

Request samples 

curl --request GET \
+

Request samples 

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'

Response samples

Content type
application/json
[
  • {
    }
]

Data Identifiers

Get Data Identifier

Return all data identifiers in the given scope.

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

Response samples

Content type
application/json
[
  • {
    }
]

Cross-Site Scripting

Allow cross-site scripting. Explicit for Authentication.

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request OPTIONS \
+  --url http://undefinedundefined/credentials/signurl \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Data Identifiers

Get Data Identifier

Return all data identifiers in the given scope.

Authorizations:
AuthToken
path Parameters
scope
required
string

The scope.

Request Body schema: application/json
name
string

The name of the did.

recursive
boolean

If specified, also returns the child ids recursively.

@@ -2792,40 +2792,48 @@

Error handling

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
[
  • {
    }
]

Get did

Returns the contents of a data identifier.

+ --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.

+
required
object

The dids to attach.

+

Responses

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.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

Responses

Request samples 

curl --request GET \
+

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
[
  • {
    }
]

Detach dids from did

Detach data identifiers from data identifiers.

+ --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.

+

Request samples

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

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
rse
string

The name of the rse.

-
account
string

The account which attaches the dids.

-
required
object

The dids to attach.

-

Responses

Request Body schema: application/json
meta
required
object

The metadata to add. A dictionary containg 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
{
  • "rse": "string",
  • "account": "string",
  • "dids": {
    }
}

Response samples

Content type
application/json
"Created"

Get metadata

Get the metadata of a did.

+

Request samples

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

Response samples

Content type
application/json
"Created"

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 \
+

Request samples 

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

Response samples

Content type
application/json
{ }

Delete metadata

Deletes the specified metadata from the did.

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

Response samples

Content type
application/json
{ }

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 containg 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"

Add metadata

Add metadata to a did.

+ --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.

key
required
string

The key for the metadata.

Request Body schema: application/json
value
required
object

The value to set.

@@ -2885,31 +2885,31 @@

Error handling

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
[
  • {
    }
]

Get followers

Get all followers for a specific did.

+ --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 follow the did.

+

Responses

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 \
+

Request samples 

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

Response samples

Content type
application/json
[
  • {
    }
]

Delete follow

Mark the input DID as not followed

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

Response samples

Content type
application/json
[
  • {
    }
]

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 unfollow the did.

Responses

Request samples

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

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 follow the did.

-

Responses

Request samples

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

Add Dids bulk

Add new Dids in bulk.

+

Request samples

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

Add Dids bulk

Add new Dids in bulk.

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

@@ -3011,13 +3011,7 @@

Error handling

Request samples 

curl --request GET \
   --url 'http://undefinedundefined/export?distance=SOME_BOOLEAN_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{ }

Heartbeat

List

List all heartbeats.

-
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/heartbeats \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • { }
]

Create

Authorizations:
AuthToken
Request Body schema: application/json
executable
string

Name of the executable.

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

Response samples

Content type
application/json
{ }

Heartbeat

Create

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

@@ -3026,7 +3020,13 @@

Error handling

Request samples

Content type
application/json
{
  • "executable": "string",
  • "hostname": "string",
  • "pid": 0,
  • "older_than": 0,
  • "payload": "string"
}

Identity

Create UserPass identity

Creates a new UserPass identity and maps it to an account.

+

Request samples

Content type
application/json
{
  • "executable": "string",
  • "hostname": "string",
  • "pid": 0,
  • "older_than": 0,
  • "payload": "string"
}

List

List all heartbeats.

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/heartbeats \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • { }
]

Identity

Create UserPass identity

Creates a new UserPass identity and maps it to an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account for the identity.

query Parameters
X-Rucio-Username
required
string

Username for the identity.

X-Rucio-Password
required
string

The password for the identity.

@@ -3063,14 +3063,7 @@

Error handling

Array of objects

Account data.

Responses

Request samples

Content type
application/json
{
  • "rses": {
    },
  • "distances": {
    },
  • "accounts": [
    ]
}

Response samples

Content type
application/json
"Created"

Lifetime Exceptions

List Exceptions

Retrieves all exceptions.

-
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/lifetime_exceptions/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Create Exception

Creates a Lifetime Exception.

+

Request samples

Content type
application/json
{
  • "rses": {
    },
  • "distances": {
    },
  • "accounts": [
    ]
}

Response samples

Content type
application/json
"Created"

Lifetime Exceptions

Create Exception

Creates a Lifetime Exception.

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

@@ -3079,7 +3072,14 @@

Error handling

Request samples

Content type
application/json
{
  • "dids": [
    ],
  • "pattern": "string",
  • "comments": "string",
  • "expires_at": "string"
}

Response samples

Content type
application/json
"string"

Get Exception

Get a single Lifetime Exception.

+

Request samples

Content type
application/json
{
  • "dids": [
    ],
  • "pattern": "string",
  • "comments": "string",
  • "expires_at": "string"
}

Response samples

Content type
application/json
"string"

List Exceptions

Retrieves all exceptions.

+
Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/lifetime_exceptions/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Get Exception

Get a single Lifetime Exception.

Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the lifetime exception.

Responses

Request samples

Content type
application/json
{
  • "key_type": "string",
  • "value_type": "string",
  • "value_regexp": "string"
}

Response samples

Content type
application/json
"Created"

Get value for key

List all values for a key.

-
Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

-

Responses

Request samples 

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

Response samples

Content type
application/json
[
  • "string"
]

Create value for key

Creates a new value for a key.

+

Request samples

Content type
application/json
{
  • "key_type": "string",
  • "value_type": "string",
  • "value_regexp": "string"
}

Response samples

Content type
application/json
"Created"

Create value for key

Creates a new value for a key.

Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

Request Body schema: application/json
value
required
string

The new value associated with a key.

Responses

Request samples

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

Response samples

Content type
application/json
"Created"

Create key

Creates a new allowed key (value is NULL).

+

Request samples

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

Response samples

Content type
application/json
"Created"

Get value for key

List all values for a key.

+
Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/meta_conventions/{key}/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • "string"
]

Create key

Creates a new allowed key (value is NULL).

Authorizations:
AuthToken
path Parameters
key
required
string

The name of the key.

Request Body schema: application/json
key_type
string

The key tpye.

value_type
string

The value type.

@@ -3147,14 +3147,7 @@

Error handling

Request samples

Content type
application/json
{
  • "key_type": "string",
  • "value_type": "string",
  • "value_regexp": "string"
}

Response samples

Content type
application/json
"Created"

Get value for key

List all values for a key.

-
Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

-

Responses

Request samples 

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

Response samples

Content type
application/json
[
  • "string"
]

Create value for key

Creates a new value for a key.

+

Request samples

Content type
application/json
{
  • "key_type": "string",
  • "value_type": "string",
  • "value_regexp": "string"
}

Response samples

Content type
application/json
"Created"

Create value for key

Creates a new value for a key.

Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

Request Body schema: application/json
value
required
string

The new value associated with a key.

Responses

Request samples

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

Response samples

Content type
application/json
"Created"

Ping

Ping

Ping the server and get data about it.

+

Request samples

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

Response samples

Content type
application/json
"Created"

Get value for key

List all values for a key.

+
Authorizations:
AuthToken
path Parameters
key
required
string

The reference key.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/meta/{key}/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • "string"
]

Ping

Ping

Ping the server and get data about it.

Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
@@ -3222,7 +3222,14 @@ 
Error handling

Request samples 

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'

Response samples

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

List Suspicious Replicas

List the suspicious replicas on a list of RSEs.

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

Response samples

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

Declare Suspicious Replicas

Declare a list of suspicious replicas.

+
Authorizations:
AuthToken
Request Body schema: application/json
pfns
Array of strings

The list of pfns.

+
reason
string

The reason for the declaration.

+

Responses

Request samples

Content type
application/json
{
  • "pfns": [
    ],
  • "reason": "string"
}

Response samples

Content type
application/json
[ ]

List Suspicious Replicas

List the suspicious replicas on a list of RSEs.

Authorizations:
AuthToken
query Parameters
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.

@@ -3230,16 +3237,9 @@

Error handling

Request samples 

curl --request GET \
+

Request samples 

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'

Response samples

Content type
application/json
[
  • {
    }
]

Declare Suspicious Replicas

Declare a list of suspicious replicas.

-
Authorizations:
AuthToken
Request Body schema: application/json
pfns
Array of strings

The list of pfns.

-
reason
string

The reason for the declaration.

-

Responses

Request samples

Content type
application/json
{
  • "pfns": [
    ],
  • "reason": "string"
}

Response samples

Content type
application/json
[ ]

List Bad Replicas By States

List the bad or suspicious replicas by states.

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

Response samples

Content type
application/json
[
  • {
    }
]

List Bad Replicas By States

List the bad or suspicious replicas by states.

Authorizations:
AuthToken
query Parameters
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.

@@ -3368,16 +3368,25 @@

Error handling

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
]

Get Subscription

Retrieve a 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 subcription.

+

Responses

Request samples

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

Response samples

Content type
application/json
"string"

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 \
+

Request samples 

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

Response samples

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

Update subscription

Update an existing subscription.

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

Response samples

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

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 subcription.

@@ -3385,16 +3394,7 @@

Error handling

Request samples

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

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 subcription.

-

Responses

Request samples

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

Response samples

Content type
application/json
"string"

Get Subscription by Name

Retrieve a subscription by name.

+

Request samples

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

Get Subscription by Name

Retrieve a subscription by name.

Authorizations:
AuthToken
path Parameters
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' \
-  --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.

@@ -3471,43 +3463,51 @@

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"

Get Rse Distances

Returns the distances between a source and destination rse.

+

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.

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 \
+

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
[
  • {
    }
]

Update Rse Distance

Update rse distance information.

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

Response samples

Content type
application/json
[
  • {
    }
]

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 the 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"

Create Rse Distance

Post a rse distance.

+

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.

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.

+
Request Body schema: application/json
distance
integer

The distance between the RSEs.

ranking
integer
Deprecated

Same as distance.

Responses

Request samples

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

Response samples

Content type
application/json
"Created"

Delete Protocol Attributes

Delete all protocol attibutes.

+

Request samples

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

Response samples

Content type
application/json
"Created"

Delete Protocol Attributes

Delete all protocol attibutes.

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.

@@ -3585,22 +3585,22 @@

Error handling

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
[
  • {
    }
]

Get Rse Limits

Get the rse limits.

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.

-

Responses

Responses

Request samples

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

Get Rse Limits

Get the rse limits.

+

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 Rse Limit

Delete an rse limit

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-

Responses

Request Body schema: application/json
name
required
string

The name of the limit.

+

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
}

Update Rse Limit

Update an rse limit.

+

Request samples

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

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
string

The name of the limit.

value
integer

The value of the limit.

@@ -3608,40 +3608,64 @@

Error handling

Request samples

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

Delete QoS Policy

Delete QoS policy from RSE.

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": 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 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.

+
latitute
number

The latitute 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 

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

Get RSE

Get details about a specific RSE.

+

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",
  • "latitute": 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.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

Responses

Request samples 

curl --request GET \
+

Request samples 

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

Response 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",
  • "latitute": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": 0,
  • "availability_write": 0,
  • "availability_delete": null
}

Update RSE

Update RSE properties.

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

Response 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",
  • "latitute": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": 0,
  • "availability_write": 0,
  • "availability_delete": null
}

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'

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.

@@ -3660,31 +3684,7 @@

Error handling

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",
  • "latitute": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
"Created"

Create RSE

Creates a RSE with all the metadata.

-
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.

-
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.

-
latitute
number

The latitute 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
{
  • "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",
  • "latitute": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true
}

Response samples

Content type
application/json
"Created"

List RSEs

Lists all RSEs.

+

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",
  • "latitute": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
"Created"

List RSEs

Lists all RSEs.

Authorizations:
AuthToken
query Parameters
expression
string

RSE expression to select RSEs.

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

Response samples

Content type
application/json
[
  • {
    }
]

Rule

Return a Rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

+

Responses

Request samples 

curl --request DELETE \
+

Request samples 

curl --request GET \
   --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"

Delete a replication rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

+

Responses

Request samples 

curl --request GET \
+

Request samples 

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

Response samples

Content type
application/json
"string"

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'

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 all rules for a given account

Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/rules/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"string"

Create a new replication rule

Authorizations:
AuthToken
Request Body schema: application/json

Parameters for the new rule.

+

Request samples

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

Create a new replication rule

Authorizations:
AuthToken
Request Body schema: application/json

Parameters for the new rule.

required
Array of objects

The list of data identifiers.

account
required
string

The account of the issuer.

copies
required
integer

The number of replicas.

@@ -3754,7 +3748,13 @@

Error handling

  • Manual Rule Approval Blocked
  • Invalid Object
    • -

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ],
    • "account": "string",
    • "copies": 0,
    • "rse_expression": "string",
    • "grouping": "string",
    • "weight": 0,
    • "lifetime": 0,
    • "locked": true,
    • "subscription_id": "string",
    • "sourse_replica_expression": "string",
    • "activity": "string",
    • "notify": "string",
    • "purge_replicas": true,
    • "ignore_availability": true,
    • "comments": "string",
    • "ask_approval": true,
    • "asynchronous": true,
    • "priority": 0,
    • "split_container": true,
    • "meta": "string"
    }

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Return all locks for a Rule

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    The id of the replication rule.

    +

    Request samples

    Content type
    application/json
    {
    • "dids": [
      ],
    • "account": "string",
    • "copies": 0,
    • "rse_expression": "string",
    • "grouping": "string",
    • "weight": 0,
    • "lifetime": 0,
    • "locked": true,
    • "subscription_id": "string",
    • "sourse_replica_expression": "string",
    • "activity": "string",
    • "notify": "string",
    • "purge_replicas": true,
    • "ignore_availability": true,
    • "comments": "string",
    • "ask_approval": true,
    • "asynchronous": true,
    • "priority": 0,
    • "split_container": true,
    • "meta": "string"
    }

    Response samples

    Content type
    application/json
    [
    • "string"
    ]

    Return all rules for a given account

    Authorizations:
    AuthToken

    Responses

    Request samples 

    curl --request GET \
+  --url http://undefinedundefined/rules/ \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

    Response samples

    Content type
    application/json
    "string"

    Return all locks for a Rule

    Authorizations:
    AuthToken
    path Parameters
    rule_id
    required
    string

    The id of the replication rule.

    Responses

    Response samples

    Content type
    application/json
    [
    • "string"
    ]