Skip to main content
GET
/
cloud
/
v1
/
file_shares
/
{project_id}
/
{region_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cloud.file_shares.list(
    project_id=1,
    region_id=1,
)
page = page.results[0]
print(page.id)
{
  "count": 1,
  "results": [
    {
      "connection_point": "10.254.0.43:/shares/share-7c14ca01-ea5e-4d85-a6e2-c104fe6b561a",
      "created_at": "<string>",
      "creator_task_id": "<string>",
      "id": "<string>",
      "name": "<string>",
      "network_id": "<string>",
      "network_name": "<string>",
      "project_id": 123,
      "protocol": "<string>",
      "region": "<string>",
      "region_id": 123,
      "share_network_name": "File_share_test-sfs_network",
      "share_settings": {
        "type_name": "<string>"
      },
      "size": 2,
      "status": "available",
      "subnet_id": "<string>",
      "subnet_name": "<string>",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "task_id": "22b1eau7-8641-4ae9-9n20-9e0b5fcd2gca",
      "type_name": "standard",
      "volume_type": "default_share_type"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID

region_id
integer
required

Region ID

Query Parameters

limit
integer
default:1000

Optional. Limit the number of returned items

Required range: x <= 1000
name
string

File share name. Uses partial match.

offset
integer
default:0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0
type_name
enum<string>

File share type name

Available options:
standard,
vast

Response

200 - application/json

OK

count
integer
required

Number of objects

Required range: x >= 0
results
FileShareSerializer · object[]
required

Objects