Skip to content

Openportal Projectinfo

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-projectinfo/ List Openportal Projectinfo
GET /api/openportal-projectinfo/{project}/ Retrieve
POST /api/openportal-projectinfo/ Create
PUT /api/openportal-projectinfo/{project}/ Update
PATCH /api/openportal-projectinfo/{project}/ Partial Update
DELETE /api/openportal-projectinfo/{project}/ Delete
Other Actions
PUT /api/openportal-projectinfo/{project}/set_allowed_destinations/ Set allowed destinations
PUT /api/openportal-projectinfo/{project}/set_shortname/ Set shortname

Core CRUD

List Openportal Projectinfo

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-projectinfo/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_projectinfo_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openportal_projectinfo_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalProjectinfoList } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string
project_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-projectinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_projectinfo_retrieve.sync(
    project=123,
    client=client
)

print(response)
  1. API Source: openportal_projectinfo_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectinfoRetrieve } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer ✓

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openportal-projectinfo/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_info_request import ProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectInfoRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_projectinfo_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectInfoRequest
  2. API Source: openportal_projectinfo_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectinfoCreate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
project string (uri) ✓
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

201 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-projectinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_info_request import ProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectInfoRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_projectinfo_update.sync(
    project=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectInfoRequest
  2. API Source: openportal_projectinfo_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalProjectinfoUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  },
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer ✓
Field Type Required Description
project string (uri) ✓
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openportal-projectinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_project_info_request import PatchedProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProjectInfoRequest()
response = openportal_projectinfo_partial_update.sync(
    project=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProjectInfoRequest
  2. API Source: openportal_projectinfo_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectinfoPartialUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer ✓
Field Type Required Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-projectinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_projectinfo_destroy.sync(
    project=123,
    client=client
)

print(response)
  1. API Source: openportal_projectinfo_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectinfoDestroy } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer ✓

204 - No response body

Other Actions

Set allowed destinations

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-projectinfo/123/set_allowed_destinations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_info_request import ProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_set_allowed_destinations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectInfoRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_projectinfo_set_allowed_destinations_update.sync(
    project=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectInfoRequest
  2. API Source: openportal_projectinfo_set_allowed_destinations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalProjectinfoSetAllowedDestinationsUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoSetAllowedDestinationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  },
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer ✓
Field Type Required Description
project string (uri) ✓
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Set shortname

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-projectinfo/123/set_shortname/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_info_request import ProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_set_shortname_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectInfoRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_projectinfo_set_shortname_update.sync(
    project=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectInfoRequest
  2. API Source: openportal_projectinfo_set_shortname_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalProjectinfoSetShortnameUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoSetShortnameUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  },
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer ✓
Field Type Required Description
project string (uri) ✓
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.