diff --git a/html/rest_api_doc.html b/html/rest_api_doc.html index fdb6f18f8d..ab42c6cb00 100644 --- a/html/rest_api_doc.html +++ b/html/rest_api_doc.html @@ -47,16 +47,16 @@ data-styled.g14[id="sc-jwIPbr"]{content:"hbTOAm,"}/*!sc*/ .gkUOTk{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ .bEpxpV{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ -.fmmJjS{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/ -.fmmJjS polygon{fill:white;}/*!sc*/ .hmCwJW{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ .hmCwJW polygon{fill:#1d8127;}/*!sc*/ +.fmmJjS{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/ +.fmmJjS polygon{fill:white;}/*!sc*/ .kVOWjS{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ .kVOWjS polygon{fill:#d41f1c;}/*!sc*/ .ccTkAM{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ .cYcqFv{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ .cYcqFv polygon{fill:#ffa500;}/*!sc*/ -data-styled.g15[id="sc-cHqXqK"]{content:"gkUOTk,bEpxpV,fmmJjS,hmCwJW,kVOWjS,ccTkAM,cYcqFv,"}/*!sc*/ +data-styled.g15[id="sc-cHqXqK"]{content:"gkUOTk,bEpxpV,hmCwJW,fmmJjS,kVOWjS,ccTkAM,cYcqFv,"}/*!sc*/ .jmDXKf{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*/ .jmDXKf +span[type]{margin-left:4px;}/*!sc*/ data-styled.g16[id="sc-jtQUzJ"]{content:"jmDXKf,"}/*!sc*/ @@ -356,12 +356,12 @@ .ebcgbH ..sc-etPtWW{color:#ffffff;}/*!sc*/ .ebcgbH: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.g112[id="sc-iPHsxv"]{content:"ebcgbH,"}/*!sc*/ -.gtVIQH{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*/ .cpnVKx{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*/ +.gtVIQH{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*/ .IVbnb{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*/ .fzqXJO{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*/ .jtqWSw{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.g113[id="sc-txhaY"]{content:"gtVIQH,cpnVKx,IVbnb,fzqXJO,jtqWSw,"}/*!sc*/ +data-styled.g113[id="sc-txhaY"]{content:"cpnVKx,gtVIQH,IVbnb,fzqXJO,jtqWSw,"}/*!sc*/ .ddApzj{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0 0 6px rgba(0, 0, 0, 0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;transition:all 0.25s ease;visibility:hidden;transform:translateY(-50%) scaleY(0);}/*!sc*/ data-styled.g114[id="sc-ePpfBx"]{content:"ddApzj,"}/*!sc*/ .evaCJX{padding:10px;}/*!sc*/ @@ -369,16 +369,16 @@ .gufODt{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/ .gufODt >span{color:#333333;}/*!sc*/ data-styled.g116[id="sc-hSyjfr"]{content:"gufODt,"}/*!sc*/ -.kQgYHQ{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*/ -.kQgYHQ:focus{outline:auto #1d8127;}/*!sc*/ -.kQgYHQ::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/ -.kQgYHQ:focus{outline:0;}/*!sc*/ +.cnBopK{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*/ +.cnBopK:focus{outline:auto #1d8127;}/*!sc*/ .ktPKSm{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*/ .ktPKSm:focus{outline:auto #d41f1c;}/*!sc*/ .ktPKSm::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/ .ktPKSm:focus{outline:0;}/*!sc*/ -.cnBopK{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*/ -.cnBopK:focus{outline:auto #1d8127;}/*!sc*/ +.kQgYHQ{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*/ +.kQgYHQ:focus{outline:auto #1d8127;}/*!sc*/ +.kQgYHQ::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/ +.kQgYHQ:focus{outline:0;}/*!sc*/ .brgVoB{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*/ .brgVoB:focus{outline:auto #ffa500;}/*!sc*/ .brgVoB::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/ @@ -387,7 +387,7 @@ .fhwTMk:focus{outline:auto #d41f1c;}/*!sc*/ .fFjNVX{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*/ .fFjNVX:focus{outline:auto #ffa500;}/*!sc*/ -data-styled.g119[id="sc-gohMHu"]{content:"kQgYHQ,ktPKSm,cnBopK,brgVoB,fhwTMk,fFjNVX,"}/*!sc*/ +data-styled.g119[id="sc-gohMHu"]{content:"cnBopK,ktPKSm,kQgYHQ,brgVoB,fhwTMk,fFjNVX,"}/*!sc*/ .beMorW{vertical-align:top;}/*!sc*/ data-styled.g122[id="sc-bKXUjo"]{content:"beMorW,"}/*!sc*/ .dheqgt{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/ @@ -426,7 +426,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 account limit

Authorizations:
AuthToken
path Parameters
account
required
string

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.

@@ -562,19 +550,19 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

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

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_expression
required
string

The rse expression 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

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.

@@ -586,21 +574,19 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

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

404

No RSE or account found for the given id.

+

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.

@@ -618,7 +604,21 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

No account found for the given id.

Request samples

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

Response samples

Content type
application/json
"Created"

Create scope

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.

@@ -682,21 +682,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

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.

-
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

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

Response samples

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

Create identity

Grant an account identity access to an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -720,7 +706,21 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Account not found

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

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 rules

Lists all rules for an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -782,47 +782,35 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

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

List account parameters

Lists all parameters for an account.

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

Response samples

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

Update

Update a parameter for an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-

Responses

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'

Update

Update a parameter for an account.

+

Request samples

Content type
application/json
{ }

List account parameters

Lists all parameters 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

406

Not acceptable

+

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

Create

Create an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -838,7 +826,19 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples

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

Response samples

Content type
application/json
"Created"

List

Request samples

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

Response samples

Content type
application/json
"Created"

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'

List

List all accounts.

Authorizations:
AuthToken

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

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

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

@@ -1378,7 +1366,19 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples

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

Response samples

Content type
application/json
"Created"

Get metadata

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 metadata

Get the metadata of a did.

Authorizations:
AuthToken
path Parameters
scope_name
required
string

The scope and the name of the did.

@@ -1396,7 +1396,23 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

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

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

Response samples

Content type
application/json
{ }

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.

@@ -1414,25 +1430,9 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

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"

Add metadata

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

@@ -1524,37 +1524,37 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

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

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

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

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

@@ -1874,21 +1874,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

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.

-
Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the lifetime exception.

-

Responses

Request samples 

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

Response samples

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

Approve/Reject exception

Request samples

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

Response samples

Content type
application/json
"string"

Approve/Reject exception

Approve/Reject a Lifetime Exception.

Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the Lifetime Exception.

@@ -1902,7 +1888,21 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "state": "A"
}

Response samples

Content type
application/json
"Created"

Lock

Get locks by rse

Request samples

Content type
application/json
{
  • "state": "A"
}

Response samples

Content type
application/json
"Created"

Get Exception

Get a single Lifetime Exception.

+
Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the lifetime exception.

+

Responses

Request samples 

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

Response samples

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

Lock

Get locks by rse

Get all dataset locks for an associated rse.

Authorizations:
AuthToken
path Parameters
rse
required
string

The rse name.

@@ -2419,23 +2419,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

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.

-
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/subscriptions/{account}/{name} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Update subscription

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

Response samples

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

Update subscription

Update an existing subscription.

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

@@ -2451,7 +2435,23 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

Request samples

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

Create 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/subscriptions/{account}/{name} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Create subscription

Create a new subscription

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

@@ -2579,21 +2579,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

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

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

@@ -2611,13 +2597,31 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

RSE not found

Request samples

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

Response samples

Content type
application/json
"Created"

Get Rse Distances

Returns the distances between a source 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'

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.

-

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

Delete distance information between source RSE 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
Error handling " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Rse not found

Request samples 

curl --request DELETE \
+

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

Update Rse Distance

Update rse distance information.

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

Response samples

Content type
application/json
[
  • {
    }
]

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.

-
Request Body schema: application/json
distance
integer

The distance between the RSEs.

+
Request Body schema: application/json
distance
integer

The distance between 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"

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

Request samples

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

Response samples

Content type
application/json
"Created"

Delete Protocol Attributes

Delete all protocol attributes.

+

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 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
Error handling " class="sc-epnzzT sc-eMwmJz drsioI ewnBNs">

The hostname of the protocol.

port
required
integer

The port of the protocol.

-

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
Error handling " class="sc-epnzzT sc-eMwmJz drsioI ewnBNs">

The hostname of the protocol.

port
required
integer

The port of the protocol.

-

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

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

@@ -2767,25 +2767,7 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

Request samples 

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

Response samples

Content type
application/json
[
  • {
    }
]

Get Rse Usage Information

Get rse usage information.

-
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
query Parameters
per_account
boolean

Boolean whether the usage should be also calculated per account or not.

-
source
string

The information source, e.g., srm.

-

Responses

Request samples 

curl --request GET \
-  --url 'http://undefinedundefined/rses/{rse}/usage?per_account=SOME_BOOLEAN_VALUE&source=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Update Rse Usage

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

Response samples

Content type
application/json
[
  • {
    }
]

Update Rse Usage

Update the RSE Update information.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2807,10 +2789,14 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Rse not found

Request samples

Content type
application/json
{
  • "source": "string",
  • "used": 0,
  • "free": 0,
  • "files": 0
}

Get Rse Usage History

Get the rse usage history

+

Request samples

Content type
application/json
{
  • "source": "string",
  • "used": 0,
  • "free": 0,
  • "files": 0
}

Get Rse Usage Information

Get rse usage information.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

+
query Parameters
per_account
boolean

Boolean whether the usage should be also calculated per account or not.

+
source
string

The information source, e.g., srm.

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

Get Rse Limits

Get the rse limits.

+

Request samples 

curl --request GET \
+  --url 'http://undefinedundefined/rses/{rse}/usage?per_account=SOME_BOOLEAN_VALUE&source=SOME_STRING_VALUE' \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

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

Get Rse Usage History

Get the rse usage history

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

Delete an rse limit

+

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

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

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
string

The name of the limit.

-
value
integer

The value of the limit.

-

Responses

Request samples

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

Delete QoS Policy

Delete QoS policy from RSE.

-
Authorizations:
AuthToken
path Parameters
rse
required
string

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.

-
policy
required
string

The QoS policy to add to and rse.

-

Responses

Request samples 

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

Add QoS policy

Request samples

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

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.

@@ -2895,35 +2879,25 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Rse not found

Request samples 

curl --request POST \
+

Request samples 

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

Response samples

Content type
application/json
"Created"

Get RSE

Get details about a specific RSE.

-
Authorizations:
AuthToken
path Parameters
rse
required
string
--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.

-

Responses

policy
required
string

The QoS policy to add to and rse.

+

Responses

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

Request samples 

curl --request DELETE \
+  --url http://undefinedundefined/rses/{rse}/qos_policy/{policy} \
+  --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.

@@ -2961,7 +2935,21 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Invalid Auth Token

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

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"

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

Create RSE

Creates a RSE with all the metadata.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -3009,7 +2997,19 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

RSE not found

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"

List RSEs

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"

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'

List RSEs

Lists all RSEs.

Authorizations:
AuthToken
query Parameters
expression
string

RSE expression to select RSEs.

@@ -3023,41 +3023,41 @@

Error handling

" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Not acceptable

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

Return a Rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string
--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.

-

Responses

Request samples 

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

Response samples

Content type
application/json
"string"

Delete a replication rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

Request samples

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

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'

Update the replication rules parameters

Authorizations:
AuthToken
path Parameters
rule_id
required
string
--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

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.

-
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 DELETE \
+  --url http://undefinedundefined/rules/{rule_id} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Return all rules for a given account

Authorizations:
AuthToken

Responses

Response samples

Content type
application/json
[
  • "string"
]