| account required | string The account for the accountlimit.
+ Delete a local account limit path Parameters| account required | string The account for the accountlimit.
+ | | rse required | string The rse for the accountlimit.
+ |
Responses/accountlimits/local/{account}/{rse} 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 path Parameters| account required | string The account for the accountlimit.
| | rse required | string The rse for the accountlimit.
|
Request Body schema: application/jsonResponses/accountlimits/local/{account}/{rse} Request samples Content typeapplication/json Response samples Content typeapplication/json Delete a local account limit path Parameters| account required | string The account for the accountlimit.
- | | rse required | string The rse for the accountlimit.
+ /accountlimits/local/{account}/{rse} Request samples Content typeapplication/json Response samples Content typeapplication/json Delete a global account limit path Parameters| account required | string The account for the accountlimit.
+ | | rse_expression required | string The rse expression for the accountlimit.
|
Responses/accountlimits/local/{account}/{rse} 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 path Parameters| account required | string The account for the accountlimit.
+ /accountlimits/global/{account}/{rse_expression} 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 path Parameters| account required | string The account for the accountlimit.
| | rse_expression required | string The rse expression for the accountlimit.
|
Request Body schema: application/jsonResponses/accountlimits/global/{account}/{rse_expression} Request samples Content typeapplication/json Response samples Content typeapplication/json Delete a global account limit path Parameters| account required | string The account for the accountlimit.
- | | rse_expression required | string The rse expression for the accountlimit.
+ /accountlimits/global/{account}/{rse_expression} Request samples Content typeapplication/json Response samples Content typeapplication/json Delete attribute Delete an attribute of an account.
+ path Parameters| account required | string The account identifier.
+ | | key required | string The key of the account attribute to remove.
|
Responses/accountlimits/global/{account}/{rse_expression} Request samples curl --request DELETE \
- --url http://undefinedundefined/accountlimits/global/{account}/{rse_expression} \
- --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'Create attribute Create an attribute to an account.
+ /accounts/{account}/attr/{key} 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.
path Parameters| account required | | | 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.
@@ -2364,15 +2372,7 @@ Error handling
/accounts/{account}/attr/{key} Request samples Content typeapplication/json {"key": "string", "value": "string"
} Response samples Content typeapplication/json Delete attribute Delete an attribute of an account.
- path Parameters| account required | string The account identifier.
- | | key required | string The key of the account attribute to remove.
- |
Responses/accounts/{account}/attr/{key} 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.
+ /accounts/{account}/attr/{key} Request samples Content typeapplication/json {"key": "string", "value": "string"
} Response samples Content typeapplication/json Create scope Creates a scopse with the given name for an account.
path Parameters| account required | | | scope required | |
Responses/accounts/{account}/limits/global/{rse_expression} 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 typeapplication/json Create identity Grant an account identity access to an account.
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/json Delete identity Delete an account identity.
+ path Parameters| account required | string The account identifier.
+ |
Request Body schema: application/json| identity required | | | authtype required | |
Responses/accounts/{account}/identities Request samples Content typeapplication/json {"identity": "string", "authtype": "string"
}Create identity Grant an account identity access to an account.
Request Body schema: application/json| identity required | | | authtype required | string The authtype.
@@ -2412,14 +2419,7 @@ Error handling
/accounts/{account}/identities Request samples Content typeapplication/json {"identity": "string", "authtype": "string", "email": "string", "password": "none", "default": false
} Response samples Content typeapplication/json Delete identity Delete an account identity.
- path Parameters| account required | string The account identifier.
- |
Request Body schema: application/json| identity required | | | authtype required | |
Responses/accounts/{account}/identities Request samples Content typeapplication/json {"identity": "string", "authtype": "string"
}List identities Lists all identities for an account.
+ /accounts/{account}/identities Request samples Content typeapplication/json {"identity": "string", "authtype": "string", "email": "string", "password": "none", "default": false
} Response samples Content typeapplication/json List identities Lists all identities for an account.
Responses/accounts/{account}/usage/global/{rse_expression} 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 typeapplication/x-json-stream Create path Parameters| account required | string The account identifier.
- |
Request Body schema: application/json| type required | string Enum: "USER" "GROUP" "SERVICE" | | email required | string The email for the account.
- |
Responses Request samples Content typeapplication/json {"type": "USER", "email": "string"
} Response samples Content typeapplication/json Update Update a parameter for an account.
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/x-json-stream Update Update a parameter for an account.
Request Body schema: application/jsonobject Json object with key-value pairs corresponding to the new values of the parameters.
Request samples Content typeapplication/json Request samples Content typeapplication/json Request samples curl --request DELETE \
+ 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.
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'Create path Parameters| account required | string The account identifier.
+ |
Request Body schema: application/json| type required | string Enum: "USER" "GROUP" "SERVICE" | | email required | string The email for the account.
+ |
Responses Request samples Content typeapplication/json {"type": "USER", "email": "string"
} Response samples Content typeapplication/json List account parameters Lists all parameters for an account.
Responses Request samples curl --request POST \
- --url http://undefinedundefined/auth/saml \
- --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' SAML Allow cross-site scripting SAML Allow cross-site scripting. Explicit for Authentication.
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'SAML Allow cross-site scripting SAML Allow cross-site scripting. Explicit for Authentication.
Request samples curl --request OPTIONS \
+ Request samples curl --request OPTIONS \
+ --url http://undefinedundefined/auth/saml \
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' 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.
header Parameters| X-Rucio-Account required | | | X-Rucio-AppID | | | X-Forwarded-For | |
Responses/dids/{scope_name}/dids/history Request samples curl --request GET \
--url http://undefinedundefined/dids/{scope_name}/dids/history \
- --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/x-json-stream [{"scope": "string", "name": "string", "type": "string", "bytes": 0, "adler32": "string", "md5": "string", "deleted_at": "string", "created_at": "string", "updated_at": "string"
}
]Add dids to did Append data identifiers to data identifiers.
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/x-json-stream [{"scope": "string", "name": "string", "type": "string", "bytes": 0, "adler32": "string", "md5": "string", "deleted_at": "string", "created_at": "string", "updated_at": "string"
}
]Detach dids from did Detach data identifiers from data identifiers.
+ path Parameters| scope_name required | string The scope and the name of the did.
+ |
Request Body schema: application/json Request samples Content typeapplication/json {"dids": [{"scope": "string", "name": "string"
}
]
}Add dids to did Append data identifiers to data identifiers.
path Parameters| scope_name required | string The scope and the name of the did.
|
Request Body schema: application/json| rse | | | account | string The account which attaches the dids.
@@ -2802,13 +2808,7 @@ Error handling
Request samples Content typeapplication/json {"rse": "string", "account": "string", "dids": {"account": "string", "scope": "string", "name": "string"
}
} Response samples Content typeapplication/json Detach dids from did Detach data identifiers from data identifiers.
- path Parameters| scope_name required | string The scope and the name of the did.
- |
Request Body schema: application/json Request samples Content typeapplication/json {"dids": [{"scope": "string", "name": "string"
}
]
}Get did Returns the contents of a data identifier.
+ Request samples Content typeapplication/json {"rse": "string", "account": "string", "dids": {"account": "string", "scope": "string", "name": "string"
}
} Response samples Content typeapplication/json Get did Returns the contents of a data identifier.
path Parameters| scope_name required | string The scope and the name of the did.
|
Responses Request samples curl --request GET \
--url http://undefinedundefined/dids/{scope_name}/dids \
- --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/x-json-stream [{"scope": "string", "name": "string", "type": "string", "bytes": 0, "adler32": "string", "md5": "string"
}
]Add metadata 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.
- |
Request samples Content typeapplication/json {"meta": { }, "recursive": false
} Response samples Content typeapplication/json Add metadata 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.
+ |
Request samples Content typeapplication/json {"meta": { }, "recursive": false
} Response samples Content typeapplication/json Post follow Mark the input DID as being followed by the given account.
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/x-json-stream Delete follow Mark the input DID as not followed
path Parameters| scope_name required | string The scope and the name of the did.
- |
Request Body schema: application/json| account required | string The account to follow the did.
- |
Responses |
Request Body schema: application/json| account required | string The account to unfollow the did.
+ |
/dids/{scope_name}/follow Request samples Content typeapplication/json Delete follow Mark the input DID as not followed
+ /dids/{scope_name}/follow Request samples Content typeapplication/json Post follow Mark the input DID as being followed by the given account.
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.
- |
|
Request Body schema: application/json| account required | string The account to follow the did.
+ |
Responses/dids/{scope_name}/follow Request samples Content typeapplication/json Get followers Get all followers for a specific did.
+ /dids/{scope_name}/follow Request samples Content typeapplication/json Get followers Get all followers for a specific did.
path Parameters| scope_name required | string The scope and the name of the did.
|
Responses/subscriptions/{account}/{name}/rules 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 typeapplication/x-json-stream Create subscription Create a new subscription
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/x-json-stream Update subscription Update an existing subscription.
path Parameters| account required | | | name required | |
Request Body schema: application/jsonrequired | object The values for the new subscription.
- |
|
Responses/subscriptions/{account}/{name} Request samples Content typeapplication/json {"options": {"filter": "string", "replication_rules": "string", "comments": "string", "lifetime": "2019-08-24T14:15:22Z", "retroactive": true, "priority": 0, "dry_run": false
}
} Response samples Content typeapplication/json Update subscription Update an existing subscription.
+ /subscriptions/{account}/{name} Request samples Content typeapplication/json {"options": {"filter": "string", "replication_rules": "string", "comments": "string", "lifetime": "2019-08-24T14:15:22Z", "retroactive": true, "priority": 0
}
}Create subscription Create a new subscription
path Parameters| account required | | | name required | |
Request Body schema: application/jsonrequired | object The values for the new subscription.
- |
|
Responses/subscriptions/{account}/{name} Request samples Content typeapplication/json {"options": {"filter": "string", "replication_rules": "string", "comments": "string", "lifetime": "2019-08-24T14:15:22Z", "retroactive": true, "priority": 0
}
}Get Subscription Retrieve a subscription.
+ /subscriptions/{account}/{name} Request samples Content typeapplication/json {"options": {"filter": "string", "replication_rules": "string", "comments": "string", "lifetime": "2019-08-24T14:15:22Z", "retroactive": true, "priority": 0, "dry_run": false
}
} Response samples Content typeapplication/json Get Subscription path Parameters| account required | | | name required | |
Responses Request samples curl --request GET \
--url 'http://undefinedundefined/requests/metrics?dest_rse=SOME_STRING_VALUE&source_rse=SOME_STRING_VALUE&activity=SOME_STRING_VALUE&group_by_rse_attribute=SOME_STRING_VALUE' \
- --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/x-json-stream [{"src_rse": "string", "dst_rse": "string", "distance": 0, "files": {"done-total-1h": 0, "done-total-6h": 0, "failed-total-1h": 0, "failed-total-6h": 0, "queued-total": 0, "queued": {"property1": 0, "property2": 0
},
}, "bytes": {"done-total-1h": 0, "done-total-6h": 0, "queued-total": 0, "queued": {"property1": 0, "property2": 0
},
}
}
]Create RSE Attribute Create a RSE attribute with given RSE name.
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/x-json-stream [{"src_rse": "string", "dst_rse": "string", "distance": 0, "files": {"done-total-1h": 0, "done-total-6h": 0, "failed-total-1h": 0, "failed-total-6h": 0, "queued-total": 0, "queued": {"property1": 0, "property2": 0
},
}, "bytes": {"done-total-1h": 0, "done-total-6h": 0, "queued-total": 0, "queued": {"property1": 0, "property2": 0
},
}
}
]Delete RSE Attribute Delete an RSE attribute for given RSE name.
+ 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.
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.
@@ -3464,42 +3472,34 @@ Error handling
Request samples Content typeapplication/json Response samples Content typeapplication/json Delete RSE Attribute Delete an RSE attribute for given RSE name.
- 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' Request samples Content typeapplication/json Response samples Content typeapplication/json Update Rse Distance Update rse distance information.
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 | |
/rses/{source}/distances/{destination} Request samples Content typeapplication/json {"distance": 0, "ranking": 0
} Response samples Content typeapplication/json Update Rse Distance Update rse distance information.
+ /rses/{source}/distances/{destination} Request samples Content typeapplication/json {"distance": 0, "ranking": 0
} Response samples Content typeapplication/json Delete Rse Distance Delete distance information between source RSE and destination RSE.
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 | |
|
/rses/{source}/distances/{destination} Request samples Content typeapplication/json {"distance": 0, "ranking": 0
} Response samples Content typeapplication/json Delete Rse Distance Delete distance information between source RSE and destination RSE.
+ /rses/{source}/distances/{destination} Request samples curl --request DELETE \
+ --url http://undefinedundefined/rses/{source}/distances/{destination} \
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/json Create Rse Distance 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 | |
/rses/{source}/distances/{destination} Request samples curl --request DELETE \
- --url http://undefinedundefined/rses/{source}/distances/{destination} \
- --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/json Get Rse Distances Returns the distances between a source and destination rse.
+ /rses/{source}/distances/{destination} Request samples Content typeapplication/json {"distance": 0, "ranking": 0
} Response samples Content typeapplication/json Get Rse Distances Returns the distances between a source and destination rse.
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/{rse}/limits \
- --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/json {"limit name1": 0, "limit name2": 0
}Add QoS policy Add a QoS Policy to a RSE.
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/json {"limit name1": 0, "limit name2": 0
}Delete QoS Policy Delete QoS policy from RSE.
path Parameters| rse required | string The name of the Rucio Storage Element name.
| | policy required | string The QoS policy to add to and rse.
- |
|
/rses/{rse}/qos_policy/{policy} Request samples /rses/{rse}/qos_policy/{policy} Request samples curl --request DELETE \
--url http://undefinedundefined/rses/{rse}/qos_policy/{policy} \
- --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE' Response samples Content typeapplication/json Delete QoS Policy Delete QoS policy from RSE.
+ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'Add QoS policy Add a QoS Policy to a RSE.
path Parameters| rse required | string The name of the Rucio Storage Element name.
| | policy required | string The QoS policy to add to and rse.
- |
|
