Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update descriptions, rename to portal_url and portal_key, other minor fixes #21

Merged
merged 5 commits into from
Jan 30, 2025
Merged

Update descriptions, rename to portal_url and portal_key, other minor fixes #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7e0eb1e
added address change and updated descriptions
unasra Jan 30, 2025
7cd9ed4
added support for bloxone env variables
unasra Jan 30, 2025
06f2190
Removed absolute name as a reuqired from dns_host
unasra Jan 30, 2025
dc45116
Updated Readme
unasra Jan 30, 2025
473a3d5
modified csp_url to portal_url and same for key
unasra Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,14 @@ The default URL for the Cloud Services Portal is `https://csp.infoblox.com`. If
from universal_ddi_client import Configuration

config = Configuration(
csp_url = "https://csp.eu.infoblox.com",
portal_url = "https://csp.eu.infoblox.com",
)
```

You can also set the URL using the environment variable `INFOBLOX_PORTAL_URL`
You can also set the URL using the environment variable `INFOBLOX_PORTAL_URL` or `BLOXONE_CSP_URL`.

> **Note:** `BLOXONE_CSP_URL` is deprecated and will be removed in future releases. It is recommended to use `INFOBLOX_PORTAL_URL` instead.


### Authorization

Expand All @@ -98,13 +101,15 @@ To use an API key with Infoblox API, you can create a new instance of Configurat
from universal_ddi_client import Configuration

config = Configuration(
api_key = "API_KEY",
portal_key = "PORTAL_KEY",
)
```

Alternatively, You can also set the API key using the environment variable `INFOBLOX_PORTAL_KEY`
Alternatively, You can also set the API key using the environment variable `INFOBLOX_PORTAL_KEY` or `BLOXONE_API_KEY` .

> **Note:** `BLOXONE_API_KEY` is deprecated and will be removed in future releases. It is recommended to use `INFOBLOX_PORTAL_KEY` instead.

Note: The API key is a secret and should be handled securely. Hardcoding the API key in your code is not recommended.
> **Note:** The API key is a secret and should be handled securely. Hardcoding the API key in your code is not recommended.

### Default Tags

Expand Down
8 changes: 4 additions & 4 deletions src/anycast/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,17 @@ import anycast
from anycast.rest import ApiException
from pprint import pprint

# Defining the CSP URL is optional and defaults to "https://csp.infoblox.com"
# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com"
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
csp_url = os.getenv('INFOBLOX_PORTAL_URL'),
portal_url = os.getenv('INFOBLOX_PORTAL_URL'),
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.

# Configure API key authorization: ApiKeyAuth
configuration.api_key = os.getenv("INFOBLOX_PORTAL_KEY")
# Configure Portal key authorization: ApiKeyAuth
configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY")


# Enter a context with an instance of the API client
Expand Down
Loading