Access Control
All operations require authentication.
List access pathsProduction
Returns the paths used to mount the share, with the preferred one first. The list stays empty until the network status of the service is associated.
Path parameters
Service name
Share ID
Response
Access path ID
Access path, in the form IP:/junction-path
Is this the preferred access path?
Example uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/1[2 {3 "id": "00000000-0000-0000-0000-000000000000",4 "path": "string",5 "preferred": true6 }7]
List ACLsProduction
Returns the ACLs of the share, including those still being applied or removed. Check the status of each ACL to know whether it is in effect.
Path parameters
Service name
Share ID
Response
Rule access level
rorwRule destination
Rule access type
ipRule creation date
Rule ID
Rule status
activeapplyingdenyingerrorqueued_to_applyqueued_to_denyExample uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/1[2 {3 "accessLevel": "ro",4 "accessTo": "string",5 "accessType": "ip",6 "createdAt": "2024-01-01T12:00:00Z",7 "id": "00000000-0000-0000-0000-000000000000",8 "status": "active"9 }10]
Get an access pathProduction
Returns the path used to mount the share. The preferred path goes through the storage node that hosts the share.
Path parameters
Access path ID
Service name
Share ID
Response
Access path ID
Access path, in the form IP:/junction-path
Is this the preferred access path?
Example uses accessPathId = 00000000-0000-0000-0000-000000000000, serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "id": "00000000-0000-0000-0000-000000000000",3 "path": "string",4 "preferred": true5}
Get an ACLProduction
Returns the ACL and its status. An ACL in error is not applied to the share: delete it and create it again.
Path parameters
Acl rule ID
Service name
Share ID
Response
Rule access level
rorwRule destination
Rule access type
ipRule creation date
Rule ID
Rule status
activeapplyingdenyingerrorqueued_to_applyqueued_to_denyExample uses aclRuleId = 00000000-0000-0000-0000-000000000000, serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "accessLevel": "ro",3 "accessTo": "string",4 "accessType": "ip",5 "createdAt": "2024-01-01T12:00:00Z",6 "id": "00000000-0000-0000-0000-000000000000",7 "status": "active"8}
Create an ACLProduction
Grants an IPv4 address or IPv4 CIDR block read-only or read-write access to the share. Creation is asynchronous: the ACL is returned with status queued_to_apply, follow its status until active. The call is rejected while the share is being created, resized, reverted or replicated.
Path parameters
Service name
Share ID
Request body (required)
Rule access level
rorwRule destination
Rule access type
ipRule creation date
Rule ID
Rule status
activeapplyingdenyingerrorqueued_to_applyqueued_to_denyResponse
Rule access level
rorwRule destination
Rule access type
ipRule creation date
Rule ID
Rule status
activeapplyingdenyingerrorqueued_to_applyqueued_to_denyExample uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "accessLevel": "ro",3 "accessTo": "string",4 "accessType": "ip",5 "createdAt": "2024-01-01T12:00:00Z",6 "id": "00000000-0000-0000-0000-000000000000",7 "status": "active"8}
Delete an ACLProduction
Revokes access to the share. Clients already mounting the share using it lose access. Deletion is asynchronous: the ACL stays listed with status queued_to_deny or denying until it is removed.
Path parameters
Acl rule ID
Service name
Share ID
Response
Example uses aclRuleId = 00000000-0000-0000-0000-000000000000, serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/