Skip to content

Commit

Permalink
Update descriptions, rename to portal_url and portal_key, other minor…
Browse files Browse the repository at this point in the history
… fixes (#21)

* added address change and updated descriptions

* added support for bloxone env variables

* Removed absolute name as a reuqired from dns_host

* Updated Readme

* modified csp_url to portal_url and same for key
  • Loading branch information
unasra authored Jan 30, 2025
1 parent c9c3dfb commit f7fe532
Show file tree
Hide file tree
Showing 98 changed files with 1,679 additions and 1,675 deletions.
15 changes: 10 additions & 5 deletions README.md
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
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

0 comments on commit f7fe532

Please sign in to comment.